Text Input

Ready

Text inputs are input fields typically used in forms that allow the user to enter text data in a structured format.

Code

Usage

Specifications

Props

Name	Default	Description
defaultValue: string		Initial value of the input, only when it is uncontrolled.
value: string		Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
label: string		Text to be placed above the input. This label will be used as the aria-label attribute of the list of suggestions.
name: string		Name attribute of the input element.
helperText: string		Helper text to be placed above the input.
placeholder: string		Text to be put as placeholder of the input.
action: object		Action to be shown in the input. This is an object composed of an onClick function and an icon, being the latter either an inline svg or a URL to the image. An example of this object is: { `onClick: function, icon: string \| svgIcon, title: string` }.
clearable: boolean	`false`	If true, the input will have an action to clear the entered value.
disabled: boolean	`false`	If true, the component will be disabled.
optional: boolean	`false`	If true, the input will be optional, showing `(Optional)` next to the label. Otherwise, the field will be considered required and an error will be passed as a parameter to the OnBlur and onChange functions when it has not been filled.
prefix: string		Prefix to be placed before the input value.
suffix: string		Suffix to be placed after the input value.
onChange: function		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. An example of this object is: { `value: value, error: error` }. If there is no error, error will not be defined.
onBlur: function		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. An example of this object is: { `value: value, error: error` }. If there is no error, error will not be defined.
error: string		If it is a defined value and also a truthy string, the component will change its appearance, showing the error below the 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.
suggestions: Array \| function		These are the options to be displayed as suggestions. It can be either an array or a function: Array: Array of options that will be filtered by the component. Function: This function will be called when the user changes the value, we will send as a parameter the new value; apart from that this function should return one promise on which we should make 'then' to get the suggestions filtered.
pattern: string		Regular expression that defines the valid format 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 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.
minLength: number		Specifies the minimun 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.
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.
autocomplete: string	`'off'`	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. Please check the documentation here.
margin: string \| object		Size of the margin to be applied to the component ('xxsmall' \| 'xsmall' \| 'small' \| 'medium' \| 'large' \| 'xlarge' \| 'xxlarge'). You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
size: string	`'medium'`	Size of the component ('small' \| 'medium' \| 'large' \| 'fillParent').
tabIndex: number	`0`	Value of the tabindex attribute.
ref: object		Reference to the component.

Examples

Controlled

() => {
  const [value, setValue] = useState("");
  const onChange = ({ value }) => {
    setValue(value);
  };
  const onBlur = ({ value }) => {
    setValue(value);
  };
  
  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your name"
        value={value}
        onChange={onChange}
        onBlur={onBlur}
      />
    </DxcInset>
  );
}

() => {
  const [value, setValue] = useState("");
  const onChange = ({ value }) => {
    setValue(value);
  };
  const onBlur = ({ value }) => {
    setValue(value);
  };
  
  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your name"
        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="2rem">
      <DxcFlex direction="column" gap="2rem" alignItems="flex-start">
        <DxcTextInput
          label="Enter your surname"
          defaultValue="Harris"
          ref={inputRef}
        />
        <DxcButton label="Submit" onClick={handleSubmit}></DxcButton>
      </DxcFlex>
    </DxcInset>
  );
}

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

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

  return (
    <DxcInset space="2rem">
      <DxcFlex direction="column" gap="2rem" alignItems="flex-start">
        <DxcTextInput
          label="Enter your surname"
          defaultValue="Harris"
          ref={inputRef}
        />
        <DxcButton label="Submit" onClick={handleSubmit}></DxcButton>
      </DxcFlex>
    </DxcInset>
  );
}

Action

() => {
  const actionIcon = {
    onClick: () => {
      console.log("Copied.");
    },
    icon: (
      <svg
        xmlns="http://www.w3.org/2000/svg"
        height="24px"
        viewBox="0 0 24 24"
        width="24px"
        fill="currentColor"
      >
        <path d="M0 0h24v24H0V0z" fill="none" />
        <path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z" />
      </svg>
    ),
    title: "Copy",
  };

  return (
    <DxcInset space="2rem">
      <DxcTextInput label="Enter your name" action={actionIcon} clearable />
    </DxcInset>
  );
}

() => {
  const actionIcon = {
    onClick: () => {
      console.log("Copied.");
    },
    icon: (
      <svg
        xmlns="http://www.w3.org/2000/svg"
        height="24px"
        viewBox="0 0 24 24"
        width="24px"
        fill="currentColor"
      >
        <path d="M0 0h24v24H0V0z" fill="none" />
        <path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z" />
      </svg>
    ),
    title: "Copy",
  };

  return (
    <DxcInset space="2rem">
      <DxcTextInput label="Enter your name" action={actionIcon} clearable />
    </DxcInset>
  );
}

Autosuggest

() => {
  const countries = ["Afghanistan", "Albania", "Algeria", "Andorra"];
  const [value, setValue] = useState("");
  const onChange = ({ value }) => {
    setValue(value);
  };
  const onBlur = ({ value }) => {
    setValue(value);
  };

  const callbackFunc = (newValue) => {
    const result = new Promise((resolve) =>
      setTimeout(() => {
        resolve(
          newValue
            ? countries.filter((option) =>
                option.toUpperCase().includes(newValue.toUpperCase())
              )
            : countries
        );
      }, 1500)
    );
    return result;
  };
  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your country"
        value={value}
        onChange={onChange}
        suggestions={callbackFunc}
        onBlur={onBlur}
      />
    </DxcInset>
  );
}

() => {
  const countries = ["Afghanistan", "Albania", "Algeria", "Andorra"];
  const [value, setValue] = useState("");
  const onChange = ({ value }) => {
    setValue(value);
  };
  const onBlur = ({ value }) => {
    setValue(value);
  };

  const callbackFunc = (newValue) => {
    const result = new Promise((resolve) =>
      setTimeout(() => {
        resolve(
          newValue
            ? countries.filter((option) =>
                option.toUpperCase().includes(newValue.toUpperCase())
              )
            : countries
        );
      }, 1500)
    );
    return result;
  };
  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your country"
        value={value}
        onChange={onChange}
        suggestions={callbackFunc}
        onBlur={onBlur}
      />
    </DxcInset>
  );
}

Error handling

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

  const validEmail = new RegExp(
    "^[a-zA-Z0-9._:$!%-]+@[a-zA-Z0-9.-]+.[a-zA-Z]$"
  );

  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your email"
        onChange={onChange}
        onBlur={onBlur}
        error={errorMessage}
        pattern={validEmail}
      />
    </DxcInset>
  );
}

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

  const validEmail = new RegExp(
    "^[a-zA-Z0-9._:$!%-]+@[a-zA-Z0-9.-]+.[a-zA-Z]$"
  );

  return (
    <DxcInset space="2rem">
      <DxcTextInput
        label="Enter your email"
        onChange={onChange}
        onBlur={onBlur}
        error={errorMessage}
        pattern={validEmail}
      />
    </DxcInset>
  );
}

Props
Examples

Edit this page on GitHub

Tag

NextTextarea

Text Input

Props

Examples

Controlled

Uncontrolled

Action

Autosuggest

Error handling

Contents