AsyncCreatableSelectField

Description

An input component with validation states and a label getting a selection from an asynchronously loaded list from the user, and where options can be created by the user.

Installation

yarn add @commercetools-uikit/async-creatable-select-field

npm --save install @commercetools-uikit/async-creatable-select-field

Additionally install the peer dependencies (if not present)

yarn add react

npm --save install react

Usage

import AsyncCreatableSelectField from '@commercetools-uikit/async-creatable-select-field';

const Example = () => (
  <AsyncCreatableSelectField
    title="State"
    name="form-field-name"
    value={{ value: 'one', label: 'One' }}
    onChange={(event) => alert(event.target.value)}
    loadOptions={() =>
      Promise.resolve([
        { value: 'one', label: 'One' },
        { value: 'two', label: 'Two' },
      ])
    }
  />
);

export default Example;

Properties

Props	Type	Required	Default	Description
id	AsyncCreatableProps['inputId']			Used as HTML id property. An id is auto-generated when it is not specified. Props from React select was used
horizontalConstraint	union Possible 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
renderError	Function See 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.
isRequired	boolean			Indicates if the value is required. Shows an the "required asterisk" if so.
touched	union Possible values: boolean[] , boolean			Indicates whether the field was touched. Errors will only be shown when the field was touched.
aria-label	AsyncCreatableProps['aria-label']			Aria label (for assistive tech) Props from React select was used
aria-labelledby	AsyncCreatableProps['aria-labelledby']			HTML ID of an element that should be used as the label (for assistive tech) Props from React select was used
isAutofocussed	boolean			Focus the control when it is mounted
backspaceRemovesValue	AsyncCreatableProps['backspaceRemovesValue']			Remove the currently focused option when the user presses backspace Props from React select was used
components	AsyncCreatableProps['components']			Map of components to overwrite the default ones, see what components you can override Props from React select was used
filterOption	AsyncCreatableProps['filterOption']			Custom method to filter whether an option should be displayed in the menu Props from React select was used
containerId	AsyncCreatableProps['id']			The id to set on the SelectContainer component Props from React select was used
isClearable	AsyncCreatableProps['isClearable']			Is the select value clearable Props from React select was used
isDisabled	AsyncCreatableProps['isDisabled']			Is the select disabled Props from React select was used
isReadOnly	boolean			Is the select read-only
isOptionDisabled	AsyncCreatableProps['isOptionDisabled']			Override the built-in logic to detect whether an option is disabled Props from React select was used
isMulti	AsyncCreatableProps['isMulti']			Support multiple selected options Props from React select was used
isSearchable	AsyncCreatableProps['isSearchable']			Whether to enable search functionality Props from React select was used
hasWarning	boolean			Indicates the input field has a warning
maxMenuHeight	AsyncCreatableProps['maxMenuHeight']			Maximum height of the menu before scrolling Props from React select was used
menuPortalTarget	AsyncCreatableProps['menuPortalTarget']			Dom element to portal the select menu to Props from React select was used
menuPortalZIndex	number			z-index value for the menu portal
menuShouldBlockScroll	AsyncCreatableProps['menuShouldBlockScroll']			whether the menu should block scroll while open Props from React select was used
name	AsyncCreatableProps['name']			Name of the HTML Input (optional - without this, no input will be rendered) Props from React select was used
noOptionsMessage	AsyncCreatableProps['noOptionsMessage']			Can be used to render a custom value when there are no options (either because of no search results, or all options have been used, or there were none in the first place). Gets called with { inputValue: String }. inputValue will be an empty string when no search text is present. Props from React select was used
onBlur	Function See signature.			Handle blur events on the control
onChange	Function See signature.	✅		Called with a fake event when value changes. The event's target.name will be the name supplied in props. The event's target.value will hold the value. The value will be the selected option, or an array of options in case isMulti is true. Props from React select was used
onFocus	AsyncCreatableProps['onFocus']			Handle focus events on the control Props from React select was used
onInputChange	AsyncCreatableProps['onInputChange']			Handle change events on the input Props from React select was used
placeholder	AsyncCreatableProps['placeholder']			Placeholder text for the select value Props from React select was used
tabIndex	AsyncCreatableProps['tabIndex']			Sets the tabIndex attribute on the input Props from React select was used
tabSelectsValue	AsyncCreatableProps['tabSelectsValue']			Select the currently focused option when the user presses tab Props from React select was used
value	AsyncCreatableProps['value']			The value of the select; reflected by the selected option Props from React select was used
showOptionGroupDivider	boolean			Determines if option groups will be separated by a divider
defaultOptions	AsyncCreatableProps['defaultOptions']			The default set of options to show before the user starts searching. When set to true, the results for loadOptions('') will be autoloaded. Props from React select was used
loadOptions	AsyncCreatableProps['loadOptions']	✅		Function that returns a promise, which is the set of options to be used once the promise resolves. Props from React select was used
cacheOptions	AsyncCreatableProps['cacheOptions']			If cacheOptions is truthy, then the loaded data will be cached. The cache will remain until cacheOptions changes value. Props from React select was used
allowCreateWhileLoading	AsyncCreatableProps['allowCreateWhileLoading']			Allow options to be created while the isLoading prop is true. Useful to prevent the "create new ..." option being displayed while async results are still being loaded. Props from React select was used
formatCreateLabel	AsyncCreatableProps['formatCreateLabel']			Gets the label for the "create new ..." option in the menu. Is given the current input value. Props from React select was used
isValidNewOption	AsyncCreatableProps['isValidNewOption']			Determines whether the "create new ..." option should be displayed based on the current input value, select value and options array. Props from React select was used
getNewOptionData	AsyncCreatableProps['getNewOptionData']			Returns the data for the new option when it is created. Used to display the value, and is passed to onChange. Props from React select was used
onCreateOption	AsyncCreatableProps['onCreateOption']			If provided, this will be called with the input value when a new option is created, and onChange will not be called. Use this when you need more control over what happens when new options are created. Props from React select was used
createOptionPosition	AsyncCreatableProps['createOptionPosition']			Sets the position of the createOption element in your options list. Props from React select was used
title	union Possible values: string , ReactNode	✅		Title of the label
hint	union Possible 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	union Possible values: string , ReactNode			Provides a description for the title.
onInfoButtonClick	Function See 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)
iconLeft	ReactNode			Icon to display on the left of the placeholder text and selected value. Has no effect when isMulti is enabled.

Signatures

Signature renderError

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

Signature onBlur

(event: TEvent) => void

Signature onChange

(event: TEvent, info: ActionMeta<unknown>) => void

Signature onInfoButtonClick

() => void

data-* props

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

This input is built on top of react-select v2. It supports mostly same properties as react-select. Behaviour for some props was changed, and support for others was dropped.

In case you need one of the currently excluded props, feel free to open a PR adding them.

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 AsyncCreatableSelectField 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 AsyncCreatableSelectField will render an appropriate error automatically.

Known error keys are:

• missing: tells the user that this field is required