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

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

@@ -222,7 +222,7 @@ AsyncSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
 } : {};
 
 // 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"] = AsyncSelectField;
 exports.version = version;

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

@@ -187,7 +187,7 @@ AsyncSelectField.getDerivedStateFromProps = (props, state) => ({
 AsyncSelectField.propTypes = {};
 
 // 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"] = AsyncSelectField;
 exports.version = version;

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

@@ -196,6 +196,6 @@ AsyncSelectField.propTypes = process.env.NODE_ENV !== "production" ? {
 } : {};
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.10.0";
 
 export { AsyncSelectField as default, version };

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

@@ -17,55 +17,272 @@ type TCustomEvent = {
     persist: () => void;
 };
 export type TAsyncSelectFieldProps = {
+    /**
+     * Used as HTML id property. An id is auto-generated when it is not specified.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     id?: ReactSelectAsyncProps['inputId'];
+    /**
+     * Horizontal size limit of the input fields.
+     */
     horizontalConstraint?: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
+    /**
+     * A map of errors. Error messages for known errors are rendered automatically.
+     * <br />
+     * Unknown errors will be forwarded to `renderError`
+     */
     errors?: TFieldErrors;
+    /**
+     * 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.
+     */
     renderError?: TErrorRenderer;
+    /**
+     * A map of warnings. Warning messages for known warnings are rendered automatically.
+     * <br />
+     * Unknown warnings will be forwarded to `renderWarning`
+     */
     warnings?: TFieldWarnings;
+    /**
+     * Called with custom warnings. This function can return a message which will be wrapped in an WarningMessage. It can also return null to show no warning.
+     */
     renderWarning?: (key: string, warning?: boolean) => ReactNode;
+    /**
+     * Indicates if the value is required. Shows an the "required asterisk" if so.
+     */
     isRequired?: boolean;
+    /**
+     * Indicates whether the field was touched. Errors will only be shown when the field was touched.
+     */
     touched?: boolean[] | 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'];
+    /**
+     * 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 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'];
+    /**
+     * Is the select read-only
+     */
     isReadOnly?: boolean;
+    /**
+     * 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'];
+    /**
+     * Indicates the input field has a warning
+     * @deprecated Please use the `warnings` prop instead so users know the reason why the field is in warning state.
+     */
     hasWarning?: boolean;
+    /**
+     * 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'];
+    /**
+     * 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).
+     * <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.
+     * <br />
+     * 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
+     */
     onFocus?: FocusEventHandler;
+    /**
+     * 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'];
+    /**
+     * Determines if option groups will be separated by a divider
+     */
     showOptionGroupDivider?: boolean;
+    /**
+     * The default set of options to show before the user starts searching.
+     * <br />
+     * When set to `true`, the results for `loadOptions('')` will be autoloaded.
+     */
     defaultOptions?: OptionsOrGroups<unknown, GroupBase<unknown>> | boolean;
+    /**
+     * Function that returns a promise, which is the set of options to be used once the promise resolves.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     loadOptions: ReactSelectAsyncProps['loadOptions'];
+    /**
+     * If cacheOptions is truthy, then the loaded data will be cached. The cache will remain until cacheOptions changes value.
+     * <br>
+     * [Props from React select was used](https://react-select.com/props)
+     */
     cacheOptions?: ReactSelectAsyncProps['cacheOptions'];
+    /**
+     * Title of the label
+     */
     title: string | ReactNode;
+    /**
+     * Hint 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`.
+     */
     hint?: string | ReactNode;
+    /**
+     * Provides a description for the title.
+     */
     description?: string | ReactNode;
+    /**
+     * Function called when info button is pressed.
+     * <br />
+     * Info button will only be visible when this prop is passed.
+     */
     onInfoButtonClick?: () => void;
+    /**
+     * Icon to be displayed beside the hint text.
+     * <br />
+     * Will only get rendered when `hint` is passed as well.
+     */
     hintIcon?: ReactElement;
+    /**
+     * Badge to be displayed beside the label.
+     * <br />
+     * Might be used to display additional information about the content of the field (E.g verified email)
+     */
     badge?: ReactNode;
+    /**
+     * Icon to display on the left of the placeholder text and selected value. Has no effect when isMulti is enabled.
+     */
     iconLeft?: ReactNode;
 };
 type TAsyncSelectFieldState = Pick<TAsyncSelectFieldProps, 'id'>;
@@ -78,6 +295,11 @@ export default class AsyncSelectField extends Component<TAsyncSelectFieldProps,
     static getDerivedStateFromProps: (props: TAsyncSelectFieldProps, state: TAsyncSelectFieldState) => {
         id: string;
     };
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
     static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/async-select-field",
   "description": "A controlled input component with validation states and a label 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/async-select-input": "19.9.0",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/field-errors": "19.9.0",
-    "@commercetools-uikit/field-label": "19.9.0",
-    "@commercetools-uikit/field-warnings": "19.9.0",
-    "@commercetools-uikit/spacings": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/async-select-input": "19.10.0",
+    "@commercetools-uikit/constraints": "19.10.0",
+    "@commercetools-uikit/design-system": "19.10.0",
+    "@commercetools-uikit/field-errors": "19.10.0",
+    "@commercetools-uikit/field-label": "19.10.0",
+    "@commercetools-uikit/field-warnings": "19.10.0",
+    "@commercetools-uikit/spacings": "19.10.0",
+    "@commercetools-uikit/utils": "19.10.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1",