16.11.0 • Published 5 months ago

@commercetools-uikit/select-field v16.11.0

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

SelectField

Description

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

Installation

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

Additionally install the peer dependencies (if not present)

yarn add react
npm --save install react

Usage

import SelectField from '@commercetools-uikit/select-field';

const Example = () => (
  <SelectField
    title="State"
    value="ready"
    options={[
      { value: 'ready', label: 'Ready' },
      { value: 'shipped', label: 'Shipped' },
    ]}
    onChange={(event) => alert(event.target.value)}
  />
);

export default Example;

Properties

PropsTypeRequiredDefaultDescription
idstringUsed as HTML id property. An id is generated automatically when not provided.
horizontalConstraintunionPossible values:, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto''scale'
errorsObjectSee signature.A map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to renderError.
renderErrorFunctionSee signature.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.
appearanceunionPossible values:'default' , 'quiet'Indicates the appearance of the input. Quiet appearance is meant to be used with the horizontalConstraint="auto".
aria-labelReactSelectProps['aria-label']Aria label (for assistive tech) Props from React select was used
aria-labelledbyReactSelectProps['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
backspaceRemovesValuebooleanRemove the currently focused option when the user presses backspace
componentsReactSelectProps['components']Map of components to overwrite the default ones, see what components you can override Props from React select was used
controlShouldRenderValueReactSelectProps['controlShouldRenderValue']Control whether the selected values should be rendered in the control Props from React select was used
filterOptionReactSelectProps['filterOption']Custom method to filter whether an option should be displayed in the menu Props from React select was used
containerIdstringThe id to set on the SelectContainer component
isClearablebooleanIs the select value clearable
isDisabledbooleanIs the select disabled
isReadOnlybooleanIs the select read-only
isOptionDisabledReactSelectProps['isOptionDisabled']Override the built-in logic to detect whether an option is disabled Props from React select was used
isMultibooleanSupport multiple selected options
isSearchablebooleanWhether to enable search functionality
maxMenuHeightnumberMaximum height of the menu before scrolling
menuPortalTargetReactSelectProps['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
menuShouldBlockScrollbooleanwhether the menu should block scroll while open
namestringName of the HTML Input (optional - without this, no input will be rendered)
noOptionsMessageReactSelectProps['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
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.
onFocusReactSelectProps['onFocus']Handle focus events on the control Props from React select was used
onInputChangeReactSelectProps['onInputChange']Handle change events on the input Props from React select was used
optionsunionPossible values:TOption[] , TOptionObject[]Array of options that populate the select menu
showOptionGroupDividerboolean
placeholderstringPlaceholder text for the select value
tabIndexReactSelectProps['tabIndex']Sets the tabIndex attribute on the input Props from React select was used
tabSelectsValuebooleanSelect the currently focused option when the user presses tab
valueReactSelectProps['value']The value of the select; reflected by the selected option Props from React select was used
titleReactNodeTitle of the label
hintReactNodeHint 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.
descriptionReactNodeProvides 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)
hasWarningbooleanControl to indicate on the input if there are selected values that are potentially invalid
iconLeftReactNodeIcon to display on the left of the placeholder text and selected value. Has no effect when isMulti is enabled.
inputValueReactSelectProps['inputValue']The value of the search input Props from React select was used

Signatures

Signature errors

{
  missing?: boolean;
}

Signature renderError

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

Signature onBlur

(event: TCustomEvent) => void

Signature onChange

(event: TCustomEvent) => void

Signature onInfoButtonClick

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

10 months ago

16.9.0

6 months ago

16.7.3

8 months ago

16.7.2

8 months ago

16.7.1

8 months ago

16.7.0

8 months ago

16.7.5

7 months ago

16.7.4

7 months ago

16.10.0

5 months ago

16.6.1

8 months ago

16.6.0

8 months ago

16.4.1

10 months ago

16.8.0

6 months ago

16.11.0

5 months ago

16.4.0

10 months ago

16.3.0

10 months ago

16.2.1

11 months ago

16.2.0

11 months ago

16.1.1

11 months ago

16.1.0

12 months ago

15.15.0

1 year ago

15.15.1

1 year ago

16.0.0

1 year ago

15.13.2

1 year ago

15.14.3

1 year 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

2 years ago

15.2.4

2 years 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.3

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

3 years ago

12.2.3

3 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.0

3 years ago

10.40.1

3 years ago

10.39.8

3 years ago

10.39.7

3 years ago

10.39.6

3 years ago

10.39.4

3 years ago

10.39.3

3 years ago

10.39.2

3 years ago

10.39.1

3 years ago

10.38.0

4 years ago

10.36.0

4 years ago

10.35.1

4 years ago

10.35.0

4 years ago

10.34.0

4 years ago

10.33.0

4 years ago

10.32.1

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.27.1

4 years ago

10.27.0

4 years ago

10.25.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.1-canary.0

4 years ago

10.17.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.3

4 years ago

10.15.2-canary.0

4 years ago

10.15.2-canary.2

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.4

4 years ago

11.0.0-alpha.2

4 years ago

11.0.0-alpha.3

4 years ago

11.0.0-alpha.1

4 years ago

11.0.0-alpha.0

4 years ago