@commercetools-uikit/creatable-select-input 19.9.0 → 19.10.0

package/dist/commercetools-uikit-creatable-select-input.cjs.dev.js

@@ -244,7 +244,7 @@ CreatableSelectInput.ValueContainer = reactSelect.components.ValueContainer;
 var CreatableSelectInput$1 = CreatableSelectInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.10.0";
 
 exports["default"] = CreatableSelectInput$1;
 exports.version = version;

package/dist/commercetools-uikit-creatable-select-input.cjs.prod.js

@@ -220,7 +220,7 @@ CreatableSelectInput.ValueContainer = reactSelect.components.ValueContainer;
 var CreatableSelectInput$1 = CreatableSelectInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.10.0";
 
 exports["default"] = CreatableSelectInput$1;
 exports.version = version;

package/dist/commercetools-uikit-creatable-select-input.esm.js

@@ -225,6 +225,6 @@ CreatableSelectInput.ValueContainer = components.ValueContainer;
 var CreatableSelectInput$1 = CreatableSelectInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.10.0";
 
 export { CreatableSelectInput$1 as default, version };

package/dist/declarations/src/creatable-select-input.d.ts

@@ -18,57 +18,266 @@ type TCustomEvent = {
 };
 type ReactSelectCreatableProps = CreatableProps<unknown, boolean, GroupBase<unknown>>;
 export type TCreatableSelectInputProps = {
+    /**
+     * Horizontal size limit of the input fields.
+     */
     horizontalConstraint?: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
+    /**
+     * Indicates the input field has an error
+     */
     hasError?: boolean;
+    /**
+     * Indicates the input field has a warning
+     */
     hasWarning?: boolean;
+    /**
+     * Disables the select input as it is read-only
+     */
     isReadOnly?: boolean;
+    /**
+     * Icon to display on the left of the placeholder text and selected value. Has no effect when `isMulti` is enabled.
+     */
     iconLeft?: ReactNode;
+    /**
+     * Aria label (for assistive tech)
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     'aria-label'?: ReactSelectCreatableProps['aria-label'];
+    /**
+     * HTML ID of an element that should be used as the label (for assistive tech)
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     'aria-labelledby'?: ReactSelectCreatableProps['aria-labelledby'];
+    /**
+     * Indicate if the value entered in the input is invalid.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     'aria-invalid'?: ReactSelectCreatableProps['aria-invalid'];
+    /**
+     * HTML ID of an element containing an error message related to the input.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     'aria-errormessage'?: ReactSelectCreatableProps['aria-errormessage'];
+    /**
+     * Focus the control when it is mounted
+     */
     isAutofocussed?: boolean;
+    /**
+     * Remove the currently focused option when the user presses backspace
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     backspaceRemovesValue?: ReactSelectCreatableProps['backspaceRemovesValue'];
+    /**
+     * Map of components to overwrite the default ones, see [what components you can override](https://react-select.com/components)
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     components?: ReactSelectCreatableProps['components'];
+    /**
+     * Custom method to filter whether an option should be displayed in the menu
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     filterOption?: ReactSelectCreatableProps['filterOption'];
+    /**
+     * The id of the search input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     id?: ReactSelectCreatableProps['inputId'];
+    /**
+     * The value of the search input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     inputValue?: ReactSelectCreatableProps['inputValue'];
+    /**
+     * The id to set on the SelectContainer component
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     containerId?: ReactSelectCreatableProps['id'];
+    /**
+     * Is the select value clearable
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isClearable?: ReactSelectCreatableProps['isClearable'];
+    /**
+     * Is the select disabled
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isDisabled?: ReactSelectCreatableProps['isDisabled'];
+    /**
+     * Override the built-in logic to detect whether an option is disabled
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isOptionDisabled?: ReactSelectCreatableProps['isOptionDisabled'];
+    /**
+     * Support multiple selected options
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isMulti?: ReactSelectCreatableProps['isMulti'];
+    /**
+     * Whether to enable search functionality
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isSearchable?: ReactSelectCreatableProps['isSearchable'];
+    /**
+     * Maximum height of the menu before scrolling
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     maxMenuHeight?: ReactSelectCreatableProps['maxMenuHeight'];
+    /**
+     * Dom element to portal the select menu to
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     menuPortalTarget?: ReactSelectCreatableProps['menuPortalTarget'];
+    /**
+     * z-index value for the menu portal
+     * <br>
+     * Use in conjunction with `menuPortalTarget`
+     */
     menuPortalZIndex: number;
+    /**
+     * whether the menu should block scroll while open
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     menuShouldBlockScroll?: ReactSelectCreatableProps['menuShouldBlockScroll'];
+    /**
+     * Whether the menu should close after a value is selected. Defaults to `true`.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     closeMenuOnSelect?: ReactSelectCreatableProps['closeMenuOnSelect'];
+    /**
+     * Name of the HTML Input (optional - without this, no input will be rendered)
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     name?: ReactSelectCreatableProps['name'];
+    /**
+     * 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.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     noOptionsMessage?: ReactSelectCreatableProps['noOptionsMessage'];
+    /**
+     * Handle blur events on the control
+     */
     onBlur?: (event: TCustomEvent) => void;
+    /**
+     * 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`.
+     */
     onChange?: (event: TCustomEvent, info: ActionMeta<unknown>) => void;
+    /**
+     * Handle focus events on the control
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     onFocus?: ReactSelectCreatableProps['onFocus'];
+    /**
+     * Handle change events on the input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     onInputChange?: ReactSelectCreatableProps['onInputChange'];
+    /**
+     * Array of options that populate the select menu
+     */
     options?: TOptions;
+    /**
+     * Determines if option groups will be separated by a divider
+     */
     showOptionGroupDivider?: boolean;
+    /**
+     * Placeholder text for the select value
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     placeholder?: ReactSelectCreatableProps['placeholder'];
+    /**
+     * Use this property to reduce the paddings of the component for a ui compact variant
+     */
     isCondensed?: boolean;
+    /**
+     * Sets the tabIndex attribute on the input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     tabIndex?: ReactSelectCreatableProps['tabIndex'];
+    /**
+     * Select the currently focused option when the user presses tab
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     tabSelectsValue?: ReactSelectCreatableProps['tabSelectsValue'];
+    /**
+     * The value of the select; reflected by the selected option
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     value?: ReactSelectCreatableProps['value'];
+    /**
+     * 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.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     allowCreateWhileLoading?: ReactSelectCreatableProps['allowCreateWhileLoading'];
+    /**
+     * Gets the label for the "create new ..." option in the menu. Is given the current input value.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     formatCreateLabel?: ReactSelectCreatableProps['formatCreateLabel'];
+    /**
+     * Determines whether the "create new ..." option should be displayed based on the current input value, select value and options array.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     isValidNewOption?: ReactSelectCreatableProps['isValidNewOption'];
+    /**
+     * Returns the data for the new option when it is created. Used to display the value, and is passed to onChange.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     getNewOptionData?: ReactSelectCreatableProps['getNewOptionData'];
+    /**
+     * 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.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     onCreateOption?: ReactSelectCreatableProps['onCreateOption'];
+    /**
+     * Sets the position of the createOption element in your options list.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props#creatable-props)
+     */
     createOptionPosition?: ReactSelectCreatableProps['createOptionPosition'];
 };
 declare const CreatableSelectInput: {
     (props: TCreatableSelectInputProps): import("@emotion/react/jsx-runtime").JSX.Element;
     displayName: string;
     defaultProps: Pick<TCreatableSelectInputProps, "value" | "isSearchable" | "menuPortalZIndex">;
+    /**
+     * Expose static helper methods.
+     */
     isTouched(touched: unknown): boolean;
+    /**
+     * Expose react-select components for customization purposes.
+     */
     ClearIndicator: {
         (props: import("@commercetools-uikit/select-utils").TClearIndicatorProps): import("@emotion/react/jsx-runtime").JSX.Element;
         displayName: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/creatable-select-input",
   "description": "An input component getting a selection from the user, and where options can also be created by the user.",
-  "version": "19.9.0",
+  "version": "19.10.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,13 +21,13 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/icons": "19.9.0",
-    "@commercetools-uikit/select-utils": "19.9.0",
-    "@commercetools-uikit/spacings": "19.9.0",
-    "@commercetools-uikit/text": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/constraints": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/icons": "19.10.0",
+    "@commercetools-uikit/select-utils": "19.10.0",
+    "@commercetools-uikit/spacings": "19.10.0",
+    "@commercetools-uikit/text": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "lodash": "4.17.21",