16.11.0 • Published 4 months ago

@commercetools-uikit/async-select-field v16.11.0

Weekly downloads
5,385
License
MIT
Repository
github
Last release
4 months ago

AsyncSelectField

Description

A controlled input component with validation states and a label getting a selection from an asynchronously loaded list from the user.

Installation

yarn add @commercetools-uikit/async-select-field
npm --save install @commercetools-uikit/async-select-field

Additionally install the peer dependencies (if not present)

yarn add react
npm --save install react

Usage

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

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

export default Example;

Properties

PropsTypeRequiredDefaultDescription
idAsyncProps['inputId']Used as HTML id property. An id is auto-generated when it is not specified. Props from React select was used
horizontalConstraintunionPossible 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.
errorsRecordA map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to renderError
renderErrorFunctionSee 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.
isRequiredbooleanIndicates if the value is required. Shows an the "required asterisk" if so.
touchedunionPossible values:boolean[] , booleanIndicates whether the field was touched. Errors will only be shown when the field was touched.
aria-labelAsyncProps['aria-label']Aria label (for assistive tech) Props from React select was used
aria-labelledbyAsyncProps['aria-labelledby']HTML ID of an element that should be used as the label (for assistive tech) Props from React select was used
isAutofocussedbooleanFocus the control when it is mounted
backspaceRemovesValueAsyncProps['backspaceRemovesValue']Remove the currently focused option when the user presses backspace Props from React select was used
componentsAsyncProps['components']Map of components to overwrite the default ones, see what components you can override Props from React select was used
controlShouldRenderValueAsyncProps['controlShouldRenderValue']trueControl whether the selected values should be rendered in the control Props from React select was used
filterOptionAsyncProps['filterOption']Custom method to filter whether an option should be displayed in the menu Props from React select was used
containerIdAsyncProps['id']The id to set on the SelectContainer component Props from React select was used
isClearableAsyncProps['isClearable']Is the select value clearable Props from React select was used
isDisabledAsyncProps['isDisabled']Is the select disabled Props from React select was used
isReadOnlybooleanIs the select read-only
isOptionDisabledAsyncProps['isOptionDisabled']Override the built-in logic to detect whether an option is disabled Props from React select was used
isMultiAsyncProps['isMulti']Support multiple selected options Props from React select was used
isSearchableAsyncProps['isSearchable']Whether to enable search functionality Props from React select was used
hasWarningbooleanIndicates the input field has a warning
maxMenuHeightAsyncProps['maxMenuHeight']Maximum height of the menu before scrolling Props from React select was used
menuPortalTargetAsyncProps['menuPortalTarget']Dom element to portal the select menu to Props from React select was used
menuPortalZIndexnumberz-index value for the menu portal Use in conjunction with menuPortalTarget
menuShouldBlockScrollAsyncProps['menuShouldBlockScroll']whether the menu should block scroll while open Props from React select was used
nameAsyncProps['name']Name of the HTML Input (optional - without this, no input will be rendered) Props from React select was used
noOptionsMessageAsyncProps['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). Props from React select was used
onBlurFunctionSee signature.Handle blur events on the control
onChangeFunctionSee 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.
onFocusFocusEventHandlerHandle focus events on the control
onInputChangeAsyncProps['onInputChange']Handle change events on the input Props from React select was used
placeholderAsyncProps['placeholder']Placeholder text for the select value Props from React select was used
loadingMessageunionPossible values:string , (() => string)loading message shown while the options are being loaded
tabIndexAsyncProps['tabIndex']Sets the tabIndex attribute on the input Props from React select was used
tabSelectsValueAsyncProps['tabSelectsValue']Select the currently focused option when the user presses tab Props from React select was used
valueAsyncProps['value']The value of the select; reflected by the selected option Props from React select was used
showOptionGroupDividerbooleanDetermines if option groups will be separated by a divider
defaultOptionsunionPossible values:OptionsOrGroups<unknown, GroupBase<unknown>> , booleanThe default set of options to show before the user starts searching. When set to true, the results for loadOptions('') will be autoloaded.
loadOptionsAsyncProps['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
cacheOptionsAsyncProps['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
titleunionPossible values:string , ReactNodeTitle of the label
hintunionPossible values:string , ReactNodeHint 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.
descriptionunionPossible values:string , ReactNodeProvides a description for the title.
onInfoButtonClickFunctionSee signature.Function called when info button is pressed. Info button will only be visible when this prop is passed.
hintIconReactElementIcon to be displayed beside the hint text. Will only get rendered when hint is passed as well.
badgeReactNodeBadge to be displayed beside the label. Might be used to display additional information about the content of the field (E.g verified email)
iconLeftReactNodeIcon 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: TCustomEvent) => void

Signature onChange

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

Signature onInfoButtonClick

() => void

data-* props

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

This field 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 AsyncSelectField 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 AsyncSelectField will render an appropriate error automatically.

Known error keys are:

  • missing: tells the user that this field is required

Static methods

AsyncSelectField.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;
};

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

9 months ago

16.9.0

5 months ago

16.7.3

7 months ago

16.7.2

7 months ago

16.7.1

7 months ago

16.7.0

7 months ago

16.7.5

6 months ago

16.7.4

6 months ago

16.10.0

4 months ago

16.6.1

7 months ago

16.6.0

8 months ago

16.4.1

9 months ago

16.4.0

9 months ago

16.8.0

5 months ago

16.11.0

4 months ago

16.3.0

9 months ago

16.2.1

10 months ago

16.2.0

10 months ago

16.1.1

10 months ago

16.1.0

11 months ago

15.15.0

11 months ago

15.15.1

11 months ago

16.0.0

11 months ago

15.13.2

1 year ago

15.14.3

12 months ago

15.14.1

1 year ago

15.14.2

1 year ago

15.14.0

1 year ago

15.13.1

1 year ago

15.13.0

1 year ago

15.12.0

1 year ago

15.9.0

1 year ago

15.10.0

1 year ago

15.11.2

1 year ago

15.11.0

1 year ago

15.11.1

1 year ago

15.7.0

1 year ago

15.8.0

1 year ago

15.5.0

1 year ago

15.5.1

1 year ago

15.6.0

1 year ago

15.4.0

1 year ago

15.3.0

1 year ago

15.2.4

1 year ago

15.2.1

2 years ago

15.2.2

2 years ago

15.2.3

2 years ago

15.1.1

2 years ago

15.1.2

2 years ago

15.1.0

2 years ago

15.2.0

2 years ago

15.0.0

2 years ago

14.0.2

2 years ago

14.0.6

2 years ago

13.0.4

2 years ago

14.0.0

2 years ago

14.0.1

2 years ago

13.0.2

2 years ago

13.0.0

2 years ago

13.0.1

2 years ago

12.2.9

2 years ago

12.2.5

2 years ago

12.2.6

2 years ago

12.2.7

2 years ago

12.2.4

2 years ago

12.2.3

2 years ago

12.2.2

3 years ago

12.2.1

3 years ago

12.2.0

3 years ago

12.1.0

3 years ago

12.0.12

3 years ago

12.0.8

3 years ago

12.0.7

3 years ago

12.0.3

3 years ago

12.0.4

3 years ago

12.0.5

3 years ago

12.0.0

3 years ago

11.2.1

3 years ago

11.2.0

3 years ago

11.1.0

3 years ago

11.0.2

3 years ago

11.0.1

3 years ago

10.47.4

3 years ago

10.47.3

3 years ago

10.47.2

3 years ago

10.47.0

3 years ago

10.46.3

3 years ago

10.46.2

3 years ago

10.46.1

3 years ago

10.45.0

3 years ago

10.44.4

3 years ago

10.44.3

3 years ago

10.44.2

3 years ago

10.44.1

3 years ago

10.44.0

3 years ago

10.43.3

3 years ago

10.43.2

3 years ago

10.43.1

3 years ago

10.42.3

3 years ago

10.42.2

3 years ago

10.42.0

3 years ago

10.42.1

3 years ago

10.41.0

3 years ago

10.40.1

3 years ago

10.40.0

3 years ago

10.39.8

3 years ago

10.39.7

3 years ago

10.39.6

3 years ago

10.39.2

3 years ago

10.39.4

3 years ago

10.39.3

3 years ago

10.39.1

3 years ago

10.38.0

3 years ago

10.36.0

3 years ago

10.35.1

4 years ago

10.35.0

4 years ago

10.34.1

4 years ago

10.34.0

4 years ago

10.33.0

4 years ago

10.32.0

4 years ago

10.31.0

4 years ago

10.30.1

4 years ago

10.30.0

4 years ago

10.29.0

4 years ago

10.27.1

4 years ago

10.27.0

4 years ago

10.24.0

4 years ago

10.22.2

4 years ago

10.22.1

4 years ago

10.22.0

4 years ago

10.21.0

4 years ago

10.20.0

4 years ago

10.19.0

4 years ago

10.18.7-canary.5

4 years ago

10.18.7-canary.6

4 years ago

10.18.7-canary.7

4 years ago

10.18.7-canary.4

4 years ago

10.18.7-canary.3

4 years ago

10.18.7-canary.2

4 years ago

10.18.7-canary.1

4 years ago

10.18.6-canary.1

4 years ago

10.18.7-canary.0

4 years ago

10.18.5-canary.4

4 years ago

10.18.6-canary.0

4 years ago

10.18.5-canary.3

4 years ago

10.18.5-canary.2

4 years ago

10.18.5-canary.1

4 years ago

10.18.5-canary.0

4 years ago

10.18.4

4 years ago

10.18.4-canary.9

4 years ago

10.18.4-canary.8

4 years ago

10.18.4-canary.7

4 years ago

10.18.4-canary.6

4 years ago

10.18.4-canary.3

4 years ago

10.18.4-canary.4

4 years ago

10.18.4-canary.5

4 years ago

10.18.4-canary.1

4 years ago

10.18.4-canary.2

4 years ago

10.18.4-canary.0

4 years ago

10.18.3-canary.2

4 years ago

10.18.3-canary.3

4 years ago

10.18.3-canary.1

4 years ago

10.18.3-canary.0

4 years ago

10.18.2

4 years ago

10.18.2-canary.3

4 years ago

10.18.2-canary.2

4 years ago

10.18.2-canary.1

4 years ago

10.17.1-canary.3

4 years ago

10.17.1-canary.2

4 years ago

10.18.1-canary.0

4 years ago

10.18.2-canary.0

4 years ago

10.18.0

4 years ago

10.17.1-canary.1

4 years ago

10.17.0

4 years ago

10.17.1-canary.0

4 years ago

10.16.1-canary.8

4 years ago

10.16.1-canary.7

4 years ago

10.16.1-canary.5

4 years ago

10.16.1-canary.6

4 years ago

10.16.1-canary.4

4 years ago

10.16.1-canary.3

4 years ago

10.16.1-canary.2

4 years ago

10.16.1-canary.1

4 years ago

10.16.1-canary.0

4 years ago

10.16.0

4 years ago

10.15.2-canary.4

4 years ago

10.15.2-canary.0

4 years ago

10.15.2-canary.2

4 years ago

10.15.2-canary.3

4 years ago

10.15.1-canary.6

4 years ago

10.15.1

4 years ago

10.15.1-canary.4

4 years ago

10.15.0

4 years ago

10.14.3-canary.4

4 years ago

10.14.1

4 years ago

10.14.1-canary.7

4 years ago

10.13.1-canary.6

4 years ago

10.13.0

4 years ago

11.0.0-alpha.11

4 years ago

11.0.0-alpha.10

4 years ago

11.0.0-alpha.9

4 years ago

11.0.0-alpha.6

4 years ago

11.0.0-alpha.7

4 years ago

11.0.0-alpha.8

4 years ago

11.0.0-alpha.5

4 years ago

11.0.0-alpha.1

4 years ago

11.0.0-alpha.2

4 years ago

11.0.0-alpha.3

4 years ago

11.0.0-alpha.4

4 years ago

11.0.0-alpha.0

4 years ago