For the complete documentation index, see llms.txt. This page is also available as Markdown.
PIN component - PinField
Availability of functionality depends on the license and may not be available in all deployments.
Component used for entering a PIN code. It currently supports 4- or 6-digit codes. The number of digits in the component depends on the implementation. The component's value is sent after the entire PIN has been entered; validation also occurs then.
✅ When to use:
When data must be entered with a strictly specified number of characters (e.g. a 4-digit login PIN code or a 6-digit SMS authorization code).
When, for security reasons, you want to mask the entered characters (the component allows masking digits with dots).
❌ When not to use:
When the length of the entered string varies (e.g. a password for an account with a length of 8 to 20 characters). Use: TextField.
Component properties
Property
Description
ARIA label (section WCAG)
Property corresponding to comma-separated attributes aria-label of the individual inputs that make up the PIN component. By default, "1,2,3,4,5,6". To make a screen reader user aware that they are in a PIN control, it may be necessary to modify this value, e.g. to "pin control 1,pin control 2,...".
Character masking in the field (section Security)
Selecting the "Character masking in the field" option in the component properties (Security section) causes the entered characters to be replaced with dots in the field view.
