@commercetools-uikit/async-select-input

AsyncSelectInput

Description

An input component getting a selection from an asynchronously loaded list from the user.

Installation

yarn add @commercetools-uikit/async-select-input

npm --save install @commercetools-uikit/async-select-input

Additionally install the peer dependencies (if not present)

yarn add react react-dom react-intl

npm --save install react react-dom react-intl

Usage

import AsyncSelectInput from '@commercetools-uikit/async-select-input';

const Example = (props) => (
  <AsyncSelectInput
    value={{ value: 'ready', label: 'Ready' }}
    loadOptions={
      (/* inputValue */) => {
        // async fetch logic
      }
    }
    onChange={(event) => alert(event.target.value)}
  />
);

export default Example;

Properties

Props	Type	Required	Default	Description
horizontalConstraint	union Possible values: , 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'			Horizontal size limit of the input fields.
hasError	boolean			Indicates the input field has an error
hasWarning	boolean			Indicates the input field has a warning
isReadOnly	boolean			Indicates that the field is displaying read-only content
aria-label	AsyncProps['aria-label']			Aria label (for assistive tech) Props from React select was used
aria-labelledby	AsyncProps['aria-labelledby']			HTML ID of an element that should be used as the label (for assistive tech) Props from React select was used
aria-invalid	AsyncProps['aria-invalid']			Indicate if the value entered in the input is invalid. Props from React select was used
aria-errormessage	AsyncProps['aria-errormessage']			HTML ID of an element containing an error message related to the input. Props from React select was used
isAutofocussed	boolean			Focus the control when it is mounted
backspaceRemovesValue	AsyncProps['backspaceRemovesValue']			Remove the currently focused option when the user presses backspace Props from React select was used
components	AsyncProps['components']			Map of components to overwrite the default ones, see what components you can override Props from React select was used
controlShouldRenderValue	AsyncProps['controlShouldRenderValue']		true	Control whether the selected values should be rendered in the control Props from React select was used
filterOption	AsyncProps['filterOption']			Custom method to filter whether an option should be displayed in the menu Props from React select was used
hideSelectedOptions	AsyncProps['hideSelectedOptions']			Custom method to determine whether selected options should be displayed in the menu Props from React select was used
id	AsyncProps['inputId']			The id of the search input Props from React select was used
inputValue	AsyncProps['inputValue']			The value of the search input Props from React select was used
containerId	AsyncProps['id']			The id to set on the SelectContainer component Props from React select was used
isClearable	AsyncProps['isClearable']			Is the select value clearable Props from React select was used
isCondensed	boolean			Use this property to reduce the paddings of the component for a ui compact variant
isDisabled	AsyncProps['isDisabled']			Is the select disabled Props from React select was used
isOptionDisabled	AsyncProps['isOptionDisabled']			Override the built-in logic to detect whether an option is disabled Props from React select was used
isMulti	AsyncProps['isMulti']			Support multiple selected options Props from React select was used
isSearchable	AsyncProps['isSearchable']		true	Whether to enable search functionality Props from React select was used
menuIsOpen	AsyncProps['menuIsOpen']			Can be used to enforce the select input to be opened Props from React select was used
maxMenuHeight	AsyncProps['maxMenuHeight']			Maximum height of the menu before scrolling Props from React select was used
menuPortalTarget	AsyncProps['menuPortalTarget']			Dom element to portal the select menu to Props from React select was used
menuPortalZIndex	number		1	z-index value for the menu portal Use in conjunction with menuPortalTarget
menuShouldBlockScroll	AsyncProps['menuShouldBlockScroll']			whether the menu should block scroll while open Props from React select was used
closeMenuOnSelect	AsyncProps['closeMenuOnSelect']			Whether the menu should close after a value is selected. Defaults to true. Props from React select was used
name	AsyncProps['name']			Name of the HTML Input (optional - without this, no input will be rendered) Props from React select was used
noOptionsMessage	AsyncProps['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.
onFocus	AsyncProps['onFocus']			Handle focus events on the control Props from React select was used
onInputChange	AsyncProps['onInputChange']			Handle change events on the input Props from React select was used
placeholder	AsyncProps['placeholder']			Placeholder text for the select value Props from React select was used
loadingMessage	union Possible values: string , (() => string)			loading message shown while the options are being loaded
tabIndex	AsyncProps['tabIndex']			Sets the tabIndex attribute on the input Props from React select was used
tabSelectsValue	AsyncProps['tabSelectsValue']			Select the currently focused option when the user presses tab Props from React select was used
value	AsyncProps['value']		null	The value of the select; reflected by the selected option Props from React select was used
defaultOptions	union Possible values: OptionsOrGroups<unknown, GroupBase<unknown>> , boolean			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	AsyncProps['loadOptions']	✅		Function that returns a promise, which is the set of options to be used once the promise resolves.
cacheOptions	AsyncProps['cacheOptions']			If cacheOptions is truthy, then the loaded data will be cached. The cache will remain until cacheOptions changes value.
showOptionGroupDivider	boolean			Determines if option groups will be separated by a divider
iconLeft	ReactNode			Icon to display on the left of the placeholder text and selected value. Has no effect when isMulti is enabled.
optionStyle	union Possible values: 'list' , 'checkbox'		'list'	defines how options are rendered
appearance	union Possible values: 'default' , 'filter'		'default'	Indicates the appearance of the input. Filter appearance is meant to be used when the async-select is used as a filter.
count	number			An additional value displayed on the select options menu. This value is only available in the checkbox option style when appearance is set to filter.

Signatures

Signature onBlur

(event: TCustomEvent) => void

Signature onChange

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

This input is built on top of react-select v2. It supports mostly same properties as react-select. Behavior 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.

Static Properties

isTouched(touched)

Returns truthy value for the Formik touched value of this input field.

Components

It is possible to customize AsyncSelectInput by passing the components property. AsyncSelectInput exports the default underlying components as static exports.

Components available as static exports are:

• ClearIndicator
• Control
• CrossIcon
• DownChevron
• DropdownIndicator
• Group
• GroupHeading
• IndicatorsContainer
• IndicatorSeparator
• Input
• LoadingIndicator
• LoadingMessage
• Menu
• MenuList
• MenuPortal
• MultiValue
• MultiValueContainer
• MultiValueLabel
• MultiValueRemove
• NoOptionsMessage
• Option
• Placeholder
• SelectContainer
• SingleValue
• ValueContainer

See the official documentation for more information about the props they receive.