Password Input

The password input component is very much like the text input, with the difference that their value is obscured by default (by replacing its characters with dot symbol ("•"), and the mask can be toggled on/off using the show and hide component action.

Props

NameTypeDescriptionDefault
valuestringValue of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.-
labelstringText to be placed above the password input.-
namestringName attribute of the input element.-
helperTextstringHelper text to be placed above the password.-
clearablebooleanIf true, the password input will have an action to clear the entered value.false
onChange(val: { value: string; error?: string }) => voidThis function will be called when the user types within the input element of the component. An object including the current value and the error (if the value entered is not valid) will be passed to this function. If there is no error, error will not be defined.-
onBlur(val: { value: string; error?: string }) => voidThis function will be called when the input element loses the focus. An object including the input value and the error (if the value entered is not valid) will be passed to this function. If there is no error, error will not be defined.-
errorstringIf it is a defined value and also a truthy string, the component will change its appearance, showing the error below the password input component. If the defined value is an empty string, it will reserve a space below the component for a future error, but it would not change its look. In case of being undefined or null, both the appearance and the space for the error message would not be modified.-
patternstringRegular expression that defines the valid format allowed by the password input. This will be checked both when the input element loses the focus and while typing within it. If the string entered does not match the pattern, the onBlur and onChange functions will be called with the current value and an internal error informing that this value does not match the pattern. If the pattern is met, the error parameter of both events will not be defined.-
minLengthnumberSpecifies the minimum length allowed by the input. This will be checked both when the input element loses the focus and while typing within it. If the string entered does not comply the minimum length, the onBlur and onChange functions will be called with the current value and an internal error informing that the value length does not comply the specified range. If a valid length is reached, the error parameter of both events will not be defined.-
maxLengthnumberSpecifies the maximum length allowed by the input. This will be checked both when the input element loses the focus and while typing within it. If the string entered does not comply the maximum length, the onBlur and onChange functions will be called with the current value and an internal error informing that the value length does not comply the specified range. If a valid length is reached, the error parameter of both events will not be defined.-
autocompletestringHTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value. Its value must be one of all the possible values of the HTML autocomplete attribute. See MDN for further information.'off'
margin'xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge' | MarginSize of the margin to be applied to the component. You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.-
size'small' | 'medium' | 'large' | 'fillParent'Size of the component.'medium'
tabIndexnumberValue of the tabindex attribute.0
refReact.Ref<HTMLDivElement>Reference to the component.-

Examples

Controlled

Uncontrolled

Error handling