NumberField

Description

A controlled input component for numbers with validation states and a label.

Installation

yarn add @commercetools-uikit/number-field

npm --save install @commercetools-uikit/number-field

Additionally install the peer dependencies (if not present)

yarn add react

npm --save install react

Usage

import NumberField from '@commercetools-uikit/number-field';

const Example = () => (
  <NumberField
    title="Age"
    value={5}
    onChange={(event) => alert(event.target.value)}
  />
);

export default Example;

Properties

| Props | Type | Required | Default | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------- | :------: | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | | | Used as HTML id property. An id is auto-generated when it is not specified. | | horizontalConstraint | unionPossible values:, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto' | | 'scale' | Horizontal size limit of the input fields. | | errors | Record | | | A map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to renderError | | warnings | Record | | | A map of warnings. Warning messages for known warnings are rendered automatically. Unknown warnings will be forwarded to renderWarning. | | renderError | FunctionSee signature. | | | Called with custom errors. This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error. | | renderWarning | FunctionSee signature. | | | Called with custom warnings, as renderWarning(key, warning). This function can return a message which will be wrapped in a WarningMessage. It can also return null to show no warning. | | isRequired | boolean | | | Indicates if the value is required. Shows an the "required asterisk" if so. | | touched | boolean | | | Indicates whether the field was touched. Errors will only be shown when the field was touched. | | name | string | | | Used as HTML name of the input component. property | | value | unionPossible values:string , number | ✅ | | Value of the input component. | | autoComplete | string | | | Used as HTML autocomplete of the input component. property | | onChange | ChangeEventHandler | | | Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value. | | onBlur | FocusEventHandler | | | Called when input is blurred | | onFocus | FocusEventHandler | | | Called when input is focused | | isAutofocussed | boolean | | | Focus the input on initial render | | isDisabled | boolean | | | Indicates that the input cannot be modified (e.g not authorized, or changes currently saving). | | isReadOnly | boolean | | | Indicates that the field is displaying read-only content | | placeholder | string | | | Placeholder text for the input | | min | number | | | Value is used as min property on input field | | max | number | | | Value is used as max property on input field | | step | unionPossible values:number , 'any' | | | Value is used as step property on input field. Use the value any for inputs which accept an unpredictable amount of decimals. | | title | unionPossible values:string , ReactNode | ✅ | | Title of the label | | hint | unionPossible values:string , ReactNode | | | Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas description can describe it in more depth. Can also receive a hintIcon. | | description | unionPossible values:string , ReactNode | | | Provides a description for the title. | | onInfoButtonClick | FunctionSee signature. | | | Function called when info button is pressed. Info button will only be visible when this prop is passed. | | hintIcon | ReactElement | | | Icon to be displayed beside the hint text. Will only get rendered when hint is passed as well. | | badge | ReactNode | | | Badge to be displayed beside the label. Might be used to display additional information about the content of the field (E.g verified email) |

Signatures

Signature renderError

(key: string, error?: boolean) => ReactNode;

Signature renderWarning

(key: string, warning?: boolean) => ReactNode;

Signature onInfoButtonClick

(
  event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>
) => void

data-* props

The component further forwards all data- attributes to the underlying input component.

onChange

The onChange function is forwarded to NumberInput as-is. See its README for documentation of the cases that can happen there, and for documentation on how to use it with Formik.

errors

This object is a key-value map. The renderError prop will be called for each entry with the key and the value. The return value will be rendered inside an ErrorMessage component underneath the input.

The NumberField supports some errors out of the box. Return undefined from renderError for these and the default errors will be shown instead. This prevents consumers from having to reimplement the same error messages for known errors while still keeping the flexibility of showing custom error messages for them.

When the key is known, and when the value is truthy, and when renderError returned undefined for that error entry, then the NumberField will render an appropriate error automatically.

Known error keys are:

• missing: tells the user that this field is required
• belowMin: tells the user that the value is below the minimum
• aboveMax: tells the user that the value is above the maximum

Static methods

NumberField.toFieldErrors

Use this function to convert the Formik errors object type to our custom field errors type. This is primarily useful when using TypeScript.

type FormValues = {
  myField: string;
};

<NumberField
  // ...
  name="my-field"
  errors={NumberField.toFieldErrors<FormValues>(formik.errors).myField}
/>;