Number Input

Ready

The number input is a text input component that only allows numerical values and it has controls for incrementing or decrementing them.

Code

Usage

Specifications

Props

Name	Default	Description
defaultValue: string		Initial value of the input element, only when it is uncontrolled.
value: string		Value of the input element. 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 number.
name: string		Name attribute of the input element.
helperText: string		Helper text to be placed above the number.
placeholder: string		Text to be put as placeholder of the number.
disabled: boolean	`false`	If true, the component will be disabled.
optional: boolean	`false`	If true, the number 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 number value.
suffix: string		Suffix to be placed after the number value.
min: number		Minimum value allowed by the number input. If the typed value by the user is lower than min, the onBlur and onChange functions will be called with the current value and an internal error informing that the current value is not correct. If a valid state is reached, the error parameter will not be defined in both events.
max: number		Maximum value allowed by the number input. If the typed value by the user surpasses max, the onBlur and onChange functions will be called with the current value and an internal error informing that the current value is not correct. If a valid state is reached, the error parameter will not be defined in both events.
step: number		The step interval to use when using the up and down arrows to adjust the 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.
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: 'on', 'off', 'email', 'username', 'new-password', ...
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 \| object	`'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">
      <DxcNumberInput
        label="Enter your age"
        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">
      <DxcNumberInput
        label="Enter your age"
        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">
        <DxcNumberInput
          label="Enter your age"
          ref={inputRef}
          defaultValue={10}
        />
        <DxcButton onClick={handleSubmit} label="Submit"></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">
        <DxcNumberInput
          label="Enter your age"
          ref={inputRef}
          defaultValue={10}
        />
        <DxcButton onClick={handleSubmit} label="Submit"></DxcButton>
      </DxcFlex>
    </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="2rem">
      <DxcNumberInput
        label="Enter your age"
        value={value}
        onChange={onChange}
        onBlur={onBlur}
        error={errorMessage}
        min={5}
        max={20}
      />
    </DxcInset>
  );
}

() => {
  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="2rem">
      <DxcNumberInput
        label="Enter your age"
        value={value}
        onChange={onChange}
        onBlur={onBlur}
        error={errorMessage}
        min={5}
        max={20}
      />
    </DxcInset>
  );
}

Edit this page on GitHub

Nav Tabs

NextPaginator

Number Input

Props

Examples

Controlled

Uncontrolled

Error handling

Contents