Password input

Password inputs provide a way for users to securely enter a password. Its 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.

Overview

Code

Props

Name	Type	Description	Default
ariaLabel	`string`	Specifies a string to be used as the name for the password input element when no `label` is provided.	`'Password input'`
autocomplete	`string`	HTML `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'`
clearable	`boolean`	If true, the password input will have an action to clear the entered value.	`false`
error	`string`	If 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.	-
helperText	`string`	Helper text to be placed above the password.	-
label	`string`	Text to be placed above the password input.	-
margin	`'xxsmall' \| 'xsmall' \| 'small' \| 'medium' \| 'large' \| 'xlarge' \| 'xxlarge' \| Margin`	Size 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.	-
maxLength	`number`	Specifies 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.	-
minLength	`number`	Specifies 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.	-
name	`string`	Name attribute of the input element.	-
onBlur	`(val: { value: string; error?: string }) => void`	This 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.	-
onChange	`(val: { value: string; error?: string }) => void`	This 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.	-
pattern	`string`	Regular 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.	-
ref	`React.Ref<HTMLDivElement>`	Reference to the component.	-
size	`'small' \| 'medium' \| 'large' \| 'fillParent'`	Size of the component.	`'medium'`
tabIndex	`number`	Value of the `tabindex` attribute.	`0`
value	`string`	Value of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.	-

Examples

Controlled

() => {
  const [value, setValue] = useState("");
  const onChange = ({ value }) => {
    setValue(value);
  };

  const onBlur = ({ value }) => {
    setValue(value);
  };

  return (
    <DxcInset space="var(--spacing-padding-xl)">
      <DxcPasswordInput
        label="Password"
        value={value}
        onChange={onChange}
        onBlur={onBlur}
      />
    </DxcInset>
  );
}

Uncontrolled

() => {
  const inputRef = useRef();

  const handleSubmit = () => {
    const input = inputRef.current.getElementsByTagName("input")[0];
    console.log(input.value);
  };

  return (
    <DxcInset space="var(--spacing-padding-xl)">
      <DxcPasswordInput label="Password" ref={inputRef} clearable />
      <DxcInset top="var(--spacing-padding-m)">
        <DxcButton onClick={handleSubmit} label="Submit" />
      </DxcInset>
    </DxcInset>
  );
}

Error handling

() => {
  const [value, setValue] = useState("");
  const [errorMessage, setErrorMessage] = useState();
  const onChange = ({ value, error }) => {
    setValue(value);
    setErrorMessage(error == undefined ? "" : "Error onChange");
  };

  const onBlur = ({ value, error }) => {
    setValue(value);
    setErrorMessage(error == undefined ? "" : "Error onBlur");
  };

  return (
    <DxcInset space="var(--spacing-padding-xl)">
      <DxcPasswordInput
        label="Password"
        helperText="Password must contain at least one lower case letter, one upper case letter and a special character."
        value={value}
        onChange={onChange}
        onBlur={onBlur}
        pattern='^.*(?=.*[a-zA-Z])(?=.*)(?=.*[!&$%&? "]).*$'
        error={errorMessage}
      />
    </DxcInset>
  );
}

Overview

Guidelines

Foundations

Migration

Utilities