Socket
Socket
Sign inDemoInstall

@commercetools-uikit/creatable-select-input

Package Overview
Dependencies
14
Maintainers
3
Versions
841
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@commercetools-uikit/creatable-select-input

An input component getting a selection from the user, and where options can also be created by the user.


Version published
Maintainers
3
Weekly downloads
4,798
decreased by-20.83%

Weekly downloads

Readme

Source

CreatableSelectInput

Description

An input component getting a selection from the user, and where options can also be created by the user.

Installation

yarn add @commercetools-uikit/creatable-select-input
npm --save install @commercetools-uikit/creatable-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 PropTypes from 'prop-types';
import CreatableSelectInput from '@commercetools-uikit/creatable-select-input';

const Example = (props) => (
  <CreatableSelectInput
    name="form-field-name"
    value={props.value}
    onChange={() => {}}
    options={[
      { value: 'one', label: 'One' },
      { value: 'two', label: 'Two' },
    ]}
  />
);
Example.propTypes = {
  value: PropTypes.string,
};
export default Example;

Properties

PropsTypeRequiredDefaultDescription
horizontalConstraintunion
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.
hasErrorbooleanIndicates the input field has an error
hasWarningbooleanIndicates the input field has a warning
isReadOnlybooleanDisables the select input as it is read-only
iconLeftReactNodeIcon to display on the left of the placeholder text and selected value. Has no effect when isMulti is enabled.
aria-labelCreatableProps['aria-label']Aria label (for assistive tech)
Props from React select was used
aria-labelledbyCreatableProps['aria-labelledby']HTML ID of an element that should be used as the label (for assistive tech)
Props from React select was used
aria-invalidCreatableProps['aria-invalid']Indicate if the value entered in the input is invalid.
Props from React select was used
aria-errormessageCreatableProps['aria-errormessage']HTML ID of an element containing an error message related to the input.
Props from React select was used
isAutofocussedbooleanFocus the control when it is mounted
backspaceRemovesValueCreatableProps['backspaceRemovesValue']Remove the currently focused option when the user presses backspace
Props from React select was used
componentsCreatableProps['components']Map of components to overwrite the default ones, see what components you can override
Props from React select was used
filterOptionCreatableProps['filterOption']Custom method to filter whether an option should be displayed in the menu
Props from React select was used
idCreatableProps['inputId']The id of the search input
Props from React select was used
inputValueCreatableProps['inputValue']The value of the search input
Props from React select was used
containerIdCreatableProps['id']The id to set on the SelectContainer component
Props from React select was used
isClearableCreatableProps['isClearable']Is the select value clearable
Props from React select was used
isDisabledCreatableProps['isDisabled']Is the select disabled
Props from React select was used
isOptionDisabledCreatableProps['isOptionDisabled']Override the built-in logic to detect whether an option is disabled
Props from React select was used
isMultiCreatableProps['isMulti']Support multiple selected options
Props from React select was used
isSearchableCreatableProps['isSearchable']trueWhether to enable search functionality
Props from React select was used
maxMenuHeightCreatableProps['maxMenuHeight']Maximum height of the menu before scrolling
Props from React select was used
menuPortalTargetCreatableProps['menuPortalTarget']Dom element to portal the select menu to
Props from React select was used
menuPortalZIndexnumber1z-index value for the menu portal
Use in conjunction with menuPortalTarget
menuShouldBlockScrollCreatableProps['menuShouldBlockScroll']whether the menu should block scroll while open
Props from React select was used
closeMenuOnSelectCreatableProps['closeMenuOnSelect']Whether the menu should close after a value is selected. Defaults to true.
Props from React select was used
nameCreatableProps['name']Name of the HTML Input (optional - without this, no input will be rendered)
Props from React select was used
noOptionsMessageCreatableProps['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
onBlurFunction
See signature.
Handle blur events on the control
onChangeFunction
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.
onFocusCreatableProps['onFocus']Handle focus events on the control
Props from React select was used
onInputChangeCreatableProps['onInputChange']Handle change events on the input
Props from React select was used
optionsunion
Possible values:
TValue[] , { options: TValue[] }[]
Array of options that populate the select menu
showOptionGroupDividerbooleanDetermines if option groups will be separated by a divider
placeholderCreatableProps['placeholder']Placeholder text for the select value
Props from React select was used
tabIndexCreatableProps['tabIndex']Sets the tabIndex attribute on the input
Props from React select was used
tabSelectsValueCreatableProps['tabSelectsValue']Select the currently focused option when the user presses tab
Props from React select was used
valueCreatableProps['value']nullThe value of the select; reflected by the selected option
Props from React select was used
allowCreateWhileLoadingCreatableProps['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
formatCreateLabelCreatableProps['formatCreateLabel']Gets the label for the "create new ..." option in the menu. Is given the current input value.
Props from React select was used
isValidNewOptionCreatableProps['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
getNewOptionDataCreatableProps['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
onCreateOptionCreatableProps['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
createOptionPositionCreatableProps['createOptionPosition']Sets the position of the createOption element in your options list.
Props from React select was used

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

options

The options support a isDisabled property which will render the option with a disabled style and will prevent users from selecting it.

Static Properties

isTouched(touched)

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

Components

It is possible to customize CreatableSelectInput by passing the components property. CreatableSelectInput 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.

Keywords

FAQs

Last updated on 22 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc