An input that masks a secret value, with buttons to reveal and copy it.
defaultRevealed |
boolean |
false |
Whether the value starts shown, when |
defaultValue | string | number | readonly string[] | – | The default value of the input. Use when uncontrolled. |
hideIcon | ReactNode | – | Replaces this icon. Accepts any node; |
labels | Partial<InputSensitiveLabels> | – | Replaces the built-in text for this instance. See |
onCopy | (() => void) | – | Called after the copy button copies the value to the clipboard. |
onRevealedChange | ((revealed: boolean) => void) | – | Called when the value is shown or hidden. |
onValueChange | ((value: string, eventDetails: Input.ChangeEventDetails) => void) | – | Callback fired when the |
revealed | boolean | – | Whether the value is shown in plain text. Use with |
revealIcon | ReactNode | – | Replaces this icon. Accepts any node; |
revealWhileTyping | boolean | true | Whether typing into the empty field shows what is typed. When |
showCopy | boolean | true | Whether to show the button that copies the value. |
size | number|"lg"|"sm"|"default" | default | The size of the component. |
value | string | number | readonly string[] | – | The value of the input. Use when controlled. |
