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

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

@@ -249,7 +249,7 @@ AsyncSelectInput.ValueContainer = reactSelect.components.ValueContainer;
 var AsyncSelectInput$1 = AsyncSelectInput;
 
 // 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"] = AsyncSelectInput$1;
 exports.version = version;

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

@@ -232,7 +232,7 @@ AsyncSelectInput.ValueContainer = reactSelect.components.ValueContainer;
 var AsyncSelectInput$1 = AsyncSelectInput;
 
 // 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"] = AsyncSelectInput$1;
 exports.version = version;

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

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

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

@@ -11,56 +11,256 @@ type TCustomEvent = {
 };
 type ReactSelectAsyncProps = AsyncProps<unknown, boolean, GroupBase<unknown>>;
 export type TAsyncSelectInputProps = {
+    /**
+     * 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;
+    /**
+     * Indicates that the field is displaying read-only content
+     */
     isReadOnly?: boolean;
+    /**
+     * Aria label (for assistive tech)
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     'aria-label'?: ReactSelectAsyncProps['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)
+     */
     'aria-labelledby'?: ReactSelectAsyncProps['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'?: ReactSelectAsyncProps['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'?: ReactSelectAsyncProps['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)
+     */
     backspaceRemovesValue?: ReactSelectAsyncProps['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)
+     */
     components?: ReactSelectAsyncProps['components'];
+    /**
+     * Control whether the selected values should be rendered in the control
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     controlShouldRenderValue?: ReactSelectAsyncProps['controlShouldRenderValue'];
+    /**
+     * 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)
+     */
     filterOption?: ReactSelectAsyncProps['filterOption'];
+    /**
+     * The id of the search input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     id?: ReactSelectAsyncProps['inputId'];
+    /**
+     * The value of the search input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     inputValue?: ReactSelectAsyncProps['inputValue'];
+    /**
+     * The id to set on the SelectContainer component
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     containerId?: ReactSelectAsyncProps['id'];
+    /**
+     * Is the select value clearable
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     isClearable?: ReactSelectAsyncProps['isClearable'];
+    /**
+     * Use this property to reduce the paddings of the component for a ui compact variant
+     */
     isCondensed?: boolean;
+    /**
+     * Is the select disabled
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     isDisabled?: ReactSelectAsyncProps['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)
+     */
     isOptionDisabled?: ReactSelectAsyncProps['isOptionDisabled'];
+    /**
+     * Support multiple selected options
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     isMulti?: ReactSelectAsyncProps['isMulti'];
+    /**
+     * Whether to enable search functionality
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     isSearchable?: ReactSelectAsyncProps['isSearchable'];
+    /**
+     * Can be used to enforce the select input to be opened
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     menuIsOpen?: ReactSelectAsyncProps['menuIsOpen'];
+    /**
+     * Maximum height of the menu before scrolling
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     maxMenuHeight?: ReactSelectAsyncProps['maxMenuHeight'];
+    /**
+     * Dom element to portal the select menu to
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     menuPortalTarget?: ReactSelectAsyncProps['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)
+     */
     menuShouldBlockScroll?: ReactSelectAsyncProps['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)
+     */
     closeMenuOnSelect?: ReactSelectAsyncProps['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)
+     */
     name?: ReactSelectAsyncProps['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)
+     */
     noOptionsMessage?: ReactSelectAsyncProps['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)
+     */
     onFocus?: ReactSelectAsyncProps['onFocus'];
+    /**
+     * Handle change events on the input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     onInputChange?: ReactSelectAsyncProps['onInputChange'];
+    /**
+     * Placeholder text for the select value
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     placeholder?: ReactSelectAsyncProps['placeholder'];
+    /**
+     * loading message shown while the options are being loaded
+     */
     loadingMessage?: string | (() => string);
+    /**
+     * Sets the tabIndex attribute on the input
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     tabIndex?: ReactSelectAsyncProps['tabIndex'];
+    /**
+     * Select the currently focused option when the user presses tab
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     tabSelectsValue?: ReactSelectAsyncProps['tabSelectsValue'];
+    /**
+     * The value of the select; reflected by the selected option
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     value?: ReactSelectAsyncProps['value'];
+    /**
+     * The default set of options to show before the user starts searching. When set to true, the results for loadOptions('') will be autoloaded.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     defaultOptions?: OptionsOrGroups<unknown, GroupBase<unknown>> | boolean;
+    /**
+     * Function that returns a promise, which is the set of options to be used once the promise resolves.
+     */
     loadOptions: ReactSelectAsyncProps['loadOptions'];
+    /**
+     * If cacheOptions is truthy, then the loaded data will be cached. The cache will remain until cacheOptions changes value.
+     */
     cacheOptions?: ReactSelectAsyncProps['cacheOptions'];
+    /**
+     * Determines if option groups will be separated by a divider
+     */
     showOptionGroupDivider?: boolean;
+    /**
+     * Icon to display on the left of the placeholder text and selected value. Has no effect when `isMulti` is enabled.
+     */
     iconLeft?: ReactNode;
 };
 declare const AsyncSelectInput: {
     (props: TAsyncSelectInputProps): import("@emotion/react/jsx-runtime").JSX.Element;
     displayName: string;
     defaultProps: Pick<TAsyncSelectInputProps, "value" | "controlShouldRenderValue" | "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;
@@ -72,7 +272,11 @@ declare const AsyncSelectInput: {
         (props: import("react-select").DropdownIndicatorProps): import("@emotion/react/jsx-runtime").JSX.Element;
         displayName: string;
     };
-    Group: <Option_3, IsMulti_3 extends boolean, Group_3 extends GroupBase<Option_3>>(props: import("react-select").GroupProps<Option_3, IsMulti_3, Group_3>) => import("@emotion/react").jsx.JSX.Element;
+    Group: <Option_3, IsMulti_3 extends boolean, Group_3 extends GroupBase<Option_3>>(props: import("react-select").GroupProps<Option_3, IsMulti_3, Group_3>) => import("@emotion/react" /**
+     * 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)
+     */).jsx.JSX.Element;
     GroupHeading: <Option_4, IsMulti_4 extends boolean, Group_4 extends GroupBase<Option_4>>(props: import("react-select").GroupHeadingProps<Option_4, IsMulti_4, Group_4>) => import("@emotion/react").jsx.JSX.Element;
     IndicatorSeparator: <Option_6, IsMulti_6 extends boolean, Group_6 extends GroupBase<Option_6>>(props: import("react-select").IndicatorSeparatorProps<Option_6, IsMulti_6, Group_6>) => import("@emotion/react").jsx.JSX.Element;
     IndicatorsContainer: <Option_5, IsMulti_5 extends boolean, Group_5 extends GroupBase<Option_5>>(props: import("react-select").IndicatorsContainerProps<Option_5, IsMulti_5, Group_5>) => import("@emotion/react").jsx.JSX.Element;
@@ -94,7 +298,11 @@ declare const AsyncSelectInput: {
     };
     NoOptionsMessage: <Option_13, IsMulti_13 extends boolean, Group_13 extends GroupBase<Option_13>>({ children, innerProps, ...restProps }: import("react-select").NoticeProps<Option_13, IsMulti_13, Group_13>) => import("@emotion/react").jsx.JSX.Element;
     Option: <Option_16, IsMulti_16 extends boolean, Group_16 extends GroupBase<Option_16>>(props: import("react-select").OptionProps<Option_16, IsMulti_16, Group_16>) => import("@emotion/react").jsx.JSX.Element;
-    Placeholder: <Option_17, IsMulti_17 extends boolean, Group_17 extends GroupBase<Option_17>>(props: import("react-select").PlaceholderProps<Option_17, IsMulti_17, Group_17>) => import("@emotion/react").jsx.JSX.Element;
+    Placeholder: <Option_17, IsMulti_17 extends boolean, Group_17 extends GroupBase<Option_17>>(props: import("react-select").PlaceholderProps<Option_17, IsMulti_17, Group_17>) => import("@emotion/react" /**
+     * 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)
+     */).jsx.JSX.Element;
     SelectContainer: <Option_18, IsMulti_18 extends boolean, Group_18 extends GroupBase<Option_18>>(props: import("react-select").ContainerProps<Option_18, IsMulti_18, Group_18>) => import("@emotion/react").jsx.JSX.Element;
     SingleValue: <Option_19, IsMulti_19 extends boolean, Group_19 extends GroupBase<Option_19>>(props: import("react-select").SingleValueProps<Option_19, IsMulti_19, Group_19>) => import("@emotion/react").jsx.JSX.Element;
     ValueContainer: <Option_20, IsMulti_20 extends boolean, Group_20 extends GroupBase<Option_20>>(props: import("react-select").ValueContainerProps<Option_20, IsMulti_20, Group_20>) => import("@emotion/react").jsx.JSX.Element;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/async-select-input",
   "description": "An input component getting a selection from an asynchronously loaded list from the user.",
-  "version": "19.9.0",
+  "version": "19.10.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,14 +21,14 @@
   "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/loading-spinner": "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/loading-spinner": "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",