BRAID
Braid Logo
 

PasswordField

Open in Playroom

Alternatives

Additional labels

Supports all three levels of FieldLabel:
  • label — primary title of the field,
  • secondaryLabel — additional context, typically used to indicate optionality of a field,
  • tertiaryLabel — further context, typically used for providing assistance with a field.
 Forgot password?
Open in Playroom

Message and tone

A message is typically used to communicate the status of a field, such as an error message. This will be announced on focus of the field and can be combined with a tone to illustrate its purpose.
The supported tones are: "critical", "positive", "caution", and "neutral".
Critical message
Positive message
Caution message
Neutral message
Open in Playroom

Field description

Additional context can be provided with a description. This will display below the field label and also be announced by a screen reader when the field is focused.
Extra information about the field
Open in Playroom

Disabled field

Mark the field as disabled by passing true to the disabled prop.
Open in Playroom

Placeholder prompt

Providing a placeholder will display as a prompt to the user no value is entered.
Open in Playroom

Toggling visibility

The button inside the field can be used to toggle the visibility of the password.
Translation hint The aria-label for the toggle visibility button can be customised by providing a visibilityToggleLabel prop.
Open in Playroom

Indirect or hidden field labels

In some cases it may be necessary for a field to be labelled by another element or even not to have a visual label. Instead of providing a label either aria-label or aria-labelledby can be provided.

Custom field label

The label for this field is the Heading element before it.
The label for this field is hidden.
Open in Playroom