Text Input

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

Props

Name	Type	Description	Default
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. Under the hood, this prop also serves as an accessible label for 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	`{ icon: string \| (React.ReactNode & React.SVGProps <SVGSVGElement>); onClick: () => void; title?: string }`	Action to be shown in the input. It has the following properties: icon: Icon to be placed in the action. It can be either an icon from Material Symbols (string) or a SVG component. onClick: Function to be called when the action button is clicked. title: Text representing advisory information related to the button's action. Under the hood, this prop also serves as an accessible label for the component. Note that if the icon is an URL (string), the component's color styling tokens will not be applied to the image.	-
clearable	`boolean`	If true, the input will have an action to clear the entered value.	`false`
disabled	`boolean`	If true, the component will be disabled.	`false`
optional	`boolean`	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.	`false`
readOnly	`boolean`	If true, the component will not be mutable, meaning the user can not edit the control. In addition, the clear action will not be displayed even if the flag is set to true and the custom action will not execute its `onClick` event.	`false`
prefix	`string`	Prefix to be placed before the input value.	-
suffix	`string`	Suffix to be placed after the input value.	-
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.	-
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.	-
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	`string[] \| ((value: string) => Promise <string[]>)`	These are the options to be displayed as suggestions. It can be either an array or a function: Array: List of options that will be filtered by the user's input. Function: This function will be called when the user changes the value. It will receive the new value as a parameter and should return a promise that resolves to an array with the filtered options.	-
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 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.	-
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`	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'`
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.	-
size	`'small' \| 'medium' \| 'large' \| 'fillParent'`	Size of the component.	`'medium'`
tabIndex	`number`	Value of the `tabindex` attribute.	`0`
ref	`React.Ref<HTMLDivElement>`	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: "Content_Copy",
    title: "Copy",
  };

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

() => {
  const actionIcon = {
    onClick: () => {
      console.log("Copied.");
    },
    icon: "Content_Copy",
    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

Report an issue on GitHub

Tag

NextTextarea

Text Input

Props

Examples

Controlled

Uncontrolled

Action

Autosuggest

Error handling

Contents