@dfds-ui/forms 2.2.0-alpha.8d87a90d → 2.2.0-alpha.98e68873

package/cjs/select-field/SelectField.d.ts

@@ -0,0 +1,95 @@
+import React from 'react';
+import Select, { ActionMeta, createFilter, GroupBase, MultiValue, OptionsOrGroups, SingleValue } from 'react-select';
+import { BaseFieldProps } from '../types';
+export declare type BaseReactSelectProps = Omit<React.PropsWithRef<Select>, 'size' | 'css'>;
+export declare type Size = 'small' | 'medium' | 'large';
+export declare const ReactSelectWrapper: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: React.ElementType<any, keyof React.JSX.IntrinsicElements> | undefined;
+} & {
+    error?: boolean | undefined;
+    size?: string | undefined;
+    arrow?: boolean | undefined;
+    selected?: boolean | undefined;
+}, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+export declare const Menu: (props: any) => React.JSX.Element;
+export declare type SelectFieldProps<T = string> = BaseFieldProps & {
+    assistiveText?: string;
+    autoFocus?: boolean;
+    className?: string;
+    components?: any;
+    defaultValue?: SingleValue<T>;
+    errorMessage?: string;
+    /**
+     * Configuration object passed to react-select createFilter function to create [custom filter
+     * logic](https://react-select.com/advanced#custom-filter-logic)
+     * @param ignoreCase - boolean (optional)
+     * @param ignoreAccents - boolean (optional)
+     * @param stringify (obj: any) => string (optional)
+     * @param trim - boolean (optional)
+     * @param matchForm - 'any' | 'start'
+     */
+    filterConfig?: Parameters<typeof createFilter>[0];
+    /**
+     * Indicates that the Select can be cleared after selecting an Option.
+     *
+     * Setting this to true will display a small dismiss cross when a value is selected
+     */
+    isClearable?: boolean;
+    isMulti?: boolean;
+    isSearchable?: boolean;
+    menuIsOpen?: boolean;
+    menuPlacement?: 'bottom' | 'auto' | 'top';
+    onBlur?: (value: any) => void;
+    onChange?: (newValue: SingleValue<T> | MultiValue<T>, actionMeta: ActionMeta<T>) => void;
+    onSelect?: (value: SingleValue<T> | MultiValue<T>) => void;
+    options?: OptionsOrGroups<T, GroupBase<T>>;
+    placeholder?: string;
+    prefix?: React.ReactNode;
+    styles?: any;
+    suffix?: React.ReactNode;
+    value?: SingleValue<T> | MultiValue<T>;
+    visualSize?: Size;
+};
+declare function SelectFieldInner<T>({ assistiveText, components, defaultValue, disabled, errorMessage, filterConfig, help, helpPlacement, hideAsterisk, isClearable, isMulti, isSearchable, label, name, onBlur, onChange, onSelect, options, placeholder, required, styles, value, visualSize, ...rest }: SelectFieldProps<T>, ref: React.ForwardedRef<any>): React.JSX.Element;
+export declare const SelectField: <T>(props: BaseFieldProps & {
+    assistiveText?: string | undefined;
+    autoFocus?: boolean | undefined;
+    className?: string | undefined;
+    components?: any;
+    defaultValue?: SingleValue<T> | undefined;
+    errorMessage?: string | undefined;
+    /**
+     * Configuration object passed to react-select createFilter function to create [custom filter
+     * logic](https://react-select.com/advanced#custom-filter-logic)
+     * @param ignoreCase - boolean (optional)
+     * @param ignoreAccents - boolean (optional)
+     * @param stringify (obj: any) => string (optional)
+     * @param trim - boolean (optional)
+     * @param matchForm - 'any' | 'start'
+     */
+    filterConfig?: Parameters<typeof createFilter>[0];
+    /**
+     * Indicates that the Select can be cleared after selecting an Option.
+     *
+     * Setting this to true will display a small dismiss cross when a value is selected
+     */
+    isClearable?: boolean | undefined;
+    isMulti?: boolean | undefined;
+    isSearchable?: boolean | undefined;
+    menuIsOpen?: boolean | undefined;
+    menuPlacement?: "top" | "bottom" | "auto" | undefined;
+    onBlur?: ((value: any) => void) | undefined;
+    onChange?: ((newValue: SingleValue<T> | MultiValue<T>, actionMeta: ActionMeta<T>) => void) | undefined;
+    onSelect?: ((value: SingleValue<T> | MultiValue<T>) => void) | undefined;
+    options?: OptionsOrGroups<T, GroupBase<T>> | undefined;
+    placeholder?: string | undefined;
+    prefix?: React.ReactNode;
+    styles?: any;
+    suffix?: React.ReactNode;
+    value?: SingleValue<T> | MultiValue<T> | undefined;
+    visualSize?: Size | undefined;
+} & {
+    ref?: React.ForwardedRef<any> | undefined;
+}) => ReturnType<typeof SelectFieldInner>;
+export default SelectField;