A form input that visually obfuscates characters to protect sensitive information by replacing them with a shape.
A Masked Input field is a special input that visually obfuscates characters to protect sensitive information by masking them with a circular shape.
Important to know
This component is meant for visual obfuscation only. Consumers should be aware that the hidden text value could still be obtained through other means (e.g., copying it from the input, via JavaScript, via the developer tools, etc.).
Usage
When to use
To give users a way to show and hide sensitive information.
When a form input with the ability to mask its value temporarily is needed.
The Masked Input is a text field designed to protect sensitive or confidential information while allowing users to show or hide the input value as needed.
The password input is a specific type of form control designed for the secure entry of passwords. The value is always masked or hidden to prevent others from reading the entered characters easily. Unlike the Masked Input, the password input has specific attributes to enhance the security and confidentiality of passwords.
Usage examples
Do
Use the Masked Input to protect sensitive values like secret keys or tokens.
Do
Use the Masked Input to protect sensitive values like variables and certificates from unintended exposure.
Don’t
Don’t use a Masked Input for password input. Use the Password input.
Multiline
Use isMultiline to display multiline textual content. e.g., a Terraform variable. This property replaces the TextInput with a Textarea field.
Required and optional
For complex forms, indicate required fields. This is the most explicit and transparent method and ensures users don’t have to make assumptions. Read more about best practices for marking required fields in forms.
The page navigation is complete. You may now navigate the page content as you wish.
A form input that visually obfuscates characters to protect sensitive information by replacing them with a shape.
A Masked Input field is a special input that visually obfuscates characters to protect sensitive information by masking them with a circular shape.
Important to know
This component is meant for visual obfuscation only. Consumers should be aware that the hidden text value could still be obtained through other means (e.g., copying it from the input, via JavaScript, via the developer tools, etc.).
Usage
When to use
To give users a way to show and hide sensitive information.
When a form input with the ability to mask its value temporarily is needed.
The Masked Input is a text field designed to protect sensitive or confidential information while allowing users to show or hide the input value as needed.
The password input is a specific type of form control designed for the secure entry of passwords. The value is always masked or hidden to prevent others from reading the entered characters easily. Unlike the Masked Input, the password input has specific attributes to enhance the security and confidentiality of passwords.
Usage examples
Do
Use the Masked Input to protect sensitive values like secret keys or tokens.
Do
Use the Masked Input to protect sensitive values like variables and certificates from unintended exposure.
Don’t
Don’t use a Masked Input for password input. Use the Password input.
Multiline
Use isMultiline to display multiline textual content. e.g., a Terraform variable. This property replaces the TextInput with a Textarea field.
Required and optional
For complex forms, indicate required fields. This is the most explicit and transparent method and ensures users don’t have to make assumptions. Read more about best practices for marking required fields in forms.
