@atlaskit/react-select 3.16.2 → 4.0.1

package/dist/types-ts4.5/types.d.ts

@@ -1,154 +0,0 @@
-import type { ReactNode } from 'react';
-import type { CSSProperties, XCSSProp } from '@compiled/react';
-import type { XCSSAllProperties, XCSSAllPseudos } from '@atlaskit/css';
-import type { SelectProps } from './select';
-import type { StylesProps } from './styles';
-export interface GroupBase<Option> {
-    readonly options: readonly Option[];
-    readonly label?: string;
-}
-export type OptionsOrGroups<Option, Group extends GroupBase<Option>> = readonly (Option | Group)[];
-export type Options<Option> = readonly Option[];
-export type SingleValue<Option> = Option | null;
-export type MultiValue<Option> = readonly Option[];
-export type PropsValue<Option> = MultiValue<Option> | SingleValue<Option>;
-export type OnChangeValue<Option, IsMulti extends boolean> = IsMulti extends true ? MultiValue<Option> : SingleValue<Option>;
-export interface Colors {
-    primary: string;
-    primary75: string;
-    primary50: string;
-    primary25: string;
-    danger: string;
-    dangerLight: string;
-    neutral0: string;
-    neutral5: string;
-    neutral10: string;
-    neutral20: string;
-    neutral30: string;
-    neutral40: string;
-    neutral50: string;
-    neutral60: string;
-    neutral70: string;
-    neutral80: string;
-    neutral90: string;
-}
-export interface ThemeSpacing {
-    baseUnit: number;
-    controlHeight: number;
-    menuGutter: number;
-}
-export interface Theme {
-    borderRadius: number;
-    colors: Colors;
-    spacing: ThemeSpacing;
-}
-export type ClassNamesState = {
-    [key: string]: boolean;
-};
-export type CX = (state: ClassNamesState, ...classNames: (string | undefined)[]) => string;
-export type GetStyles<Option, IsMulti extends boolean, Group extends GroupBase<Option>> = <Key extends keyof StylesProps<Option, IsMulti, Group>>(propertyName: Key, props: StylesProps<Option, IsMulti, Group>[Key]) => CSSObjectWithLabel;
-export interface CommonProps<Option, IsMulti extends boolean, Group extends GroupBase<Option>> {
-    clearValue: () => void;
-    cx: CX;
-    /**
-     * Get the styles of a particular part of the select. Pass in the name of the
-     * property as the first argument, and the current props as the second argument.
-     * See the `styles` object for the properties available.
-     */
-    getStyles: GetStyles<Option, IsMulti, Group>;
-    getClassNames: <Key extends keyof StylesProps<Option, IsMulti, Group>>(propertyName: Key, props: StylesProps<Option, IsMulti, Group>[Key]) => string | undefined;
-    getValue: () => Options<Option>;
-    hasValue: boolean;
-    isMulti: boolean;
-    isRtl: boolean;
-    options: OptionsOrGroups<Option, Group>;
-    selectOption: (newValue: Option) => void;
-    selectProps: SelectProps<Option, IsMulti, Group>;
-    setValue: (newValue: OnChangeValue<Option, IsMulti>, action: SetValueAction, option?: Option) => void;
-}
-export interface CommonPropsAndClassName<Option, IsMulti extends boolean, Group extends GroupBase<Option>> extends CommonProps<Option, IsMulti, Group> {
-    className?: string | undefined;
-    xcss?: XCSSProp<XCSSAllProperties, XCSSAllPseudos> | undefined;
-}
-export interface ActionMetaBase<Option> {
-    option?: Option | undefined;
-    removedValue?: Option;
-    removedValues?: Options<Option>;
-    name?: string;
-}
-export interface SelectOptionActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'select-option';
-    option: Option | undefined;
-    name?: string;
-}
-export interface DeselectOptionActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'deselect-option';
-    option: Option | undefined;
-    name?: string;
-}
-export interface RemoveValueActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'remove-value';
-    removedValue: Option;
-    name?: string;
-}
-export interface PopValueActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'pop-value';
-    removedValue: Option;
-    name?: string;
-}
-export interface ClearActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'clear';
-    removedValues: Options<Option>;
-    name?: string;
-}
-export interface CreateOptionActionMeta<Option> extends ActionMetaBase<Option> {
-    action: 'create-option';
-    name?: string;
-    option: Option;
-}
-export interface InitialInputFocusedActionMeta<Option, IsMulti extends boolean> extends ActionMetaBase<Option> {
-    action: 'initial-input-focus';
-    value: OnChangeValue<Option, IsMulti>;
-    options?: Options<Option>;
-}
-export type ActionMeta<Option> = SelectOptionActionMeta<Option> | DeselectOptionActionMeta<Option> | RemoveValueActionMeta<Option> | PopValueActionMeta<Option> | ClearActionMeta<Option> | CreateOptionActionMeta<Option>;
-export type SetValueAction = 'select-option' | 'deselect-option';
-export type InputAction = 'set-value' | 'input-change' | 'input-blur' | 'menu-close';
-export interface InputActionMeta {
-    action: InputAction;
-    /**
-     * The previous value of the search input.
-     */
-    prevInputValue: string;
-}
-export type MenuPlacement = 'auto' | 'bottom' | 'top';
-export type CoercedMenuPlacement = 'bottom' | 'top';
-export type MenuPosition = 'absolute' | 'fixed';
-export type FocusDirection = 'up' | 'down' | 'pageup' | 'pagedown' | 'first' | 'last';
-export type GetOptionLabel<Option> = (option: Option) => string;
-export type GetOptionValue<Option> = (option: Option) => string;
-export type CSSObjectWithLabel = any;
-export interface MultiValueGenericProps<Option = unknown, IsMulti extends boolean = boolean, Group extends GroupBase<Option> = GroupBase<Option>> {
-    children: ReactNode;
-    data: any;
-    innerProps: {
-        className?: string;
-        style?: CSSProperties;
-    };
-    selectProps: SelectProps<Option, IsMulti, Group>;
-    isFocused?: boolean;
-    isDisabled?: boolean;
-    hasEllipsis?: boolean;
-    className?: string | undefined;
-    xcss?: XCSSProp<XCSSAllProperties, XCSSAllPseudos> | undefined;
-}
-export interface NoticeProps<Option = unknown, IsMulti extends boolean = boolean, Group extends GroupBase<Option> = GroupBase<Option>> extends CommonPropsAndClassName<Option, IsMulti, Group> {
-    /**
-     * The children to be rendered.
-     */
-    children: ReactNode;
-    /**
-     * Props to be passed on to the wrapper.
-     */
-    innerProps: JSX.IntrinsicElements['div'];
-}

package/dist/types-ts4.5/use-async.d.ts

@@ -1,31 +0,0 @@
-import type { GroupBase, OptionsOrGroups } from './types';
-import type { StateManagerProps } from './use-state-manager';
-type AsyncManagedPropKeys = 'options' | 'isLoading' | 'onInputChange' | 'filterOption';
-export interface AsyncAdditionalProps<Option, Group extends GroupBase<Option>> {
-    /**
-     * The default set of options to show before the user starts searching. When
-     * set to `true`, the results for loadOptions('') will be autoloaded.
-     */
-    defaultOptions?: OptionsOrGroups<Option, Group> | boolean;
-    /**
-     * If cacheOptions is truthy, then the loaded data will be cached. The cache
-     * will remain until `cacheOptions` changes value.
-     */
-    cacheOptions?: any;
-    /**
-     * Function that returns a promise, which is the set of options to be used
-     * once the promise resolves.
-     */
-    loadOptions?: (inputValue: string, callback: (options: OptionsOrGroups<Option, Group>) => void) => Promise<OptionsOrGroups<Option, Group>> | void;
-    /**
-     * Will cause the select to be displayed in the loading state, even if the
-     * Async select is not currently waiting for loadOptions to resolve
-     */
-    isLoading?: boolean;
-}
-export type AsyncProps<Option, IsMulti extends boolean, Group extends GroupBase<Option>> = StateManagerProps<Option, IsMulti, Group> & AsyncAdditionalProps<Option, Group>;
-/**
- * {description}.
- */
-export default function useAsync<Option, IsMulti extends boolean, Group extends GroupBase<Option>, AdditionalProps>({ defaultOptions: propsDefaultOptions, cacheOptions, loadOptions: propsLoadOptions, options: propsOptions, isLoading: propsIsLoading, onInputChange: propsOnInputChange, filterOption, ...restSelectProps }: AsyncProps<Option, IsMulti, Group> & AdditionalProps): StateManagerProps<Option, IsMulti, Group> & Omit<AdditionalProps, keyof AsyncAdditionalProps<Option, Group> | AsyncManagedPropKeys>;
-export {};

package/dist/types-ts4.5/use-creatable.d.ts

@@ -1,46 +0,0 @@
-import { type ReactNode } from 'react';
-import type { PublicBaseSelectProps } from './select';
-import { type GetOptionLabel, type GetOptionValue, type GroupBase, type Options, type OptionsOrGroups } from './types';
-interface Accessors<Option> {
-    getOptionValue: GetOptionValue<Option>;
-    getOptionLabel: GetOptionLabel<Option>;
-}
-export interface CreatableAdditionalProps<Option, Group extends GroupBase<Option>> {
-    /**
-     * 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.
-     */
-    allowCreateWhileLoading?: boolean;
-    /**
-     * Sets the position of the createOption element in your options list. Defaults to 'last'
-     */
-    createOptionPosition?: 'first' | 'last';
-    /**
-     * Gets the label for the "create new ..." option in the menu. Is given the
-     * current input value.
-     */
-    formatCreateLabel?: (inputValue: string) => ReactNode;
-    /**
-     * Determines whether the "create new ..." option should be displayed based on
-     * the current input value, select value and options array.
-     */
-    isValidNewOption?: (inputValue: string, value: Options<Option>, options: OptionsOrGroups<Option, Group>, accessors: Accessors<Option>) => boolean;
-    /**
-     * Returns the data for the new option when it is created. Used to display the
-     * value, and is passed to `onChange`.
-     */
-    getNewOptionData?: (inputValue: string, optionLabel: ReactNode) => Option;
-    /**
-     * 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.
-     */
-    onCreateOption?: (inputValue: string) => void;
-}
-type BaseCreatableProps<Option, IsMulti extends boolean, Group extends GroupBase<Option>> = PublicBaseSelectProps<Option, IsMulti, Group> & CreatableAdditionalProps<Option, Group>;
-/**
- * {description}.
- */
-export default function useCreatable<Option, IsMulti extends boolean, Group extends GroupBase<Option>>({ allowCreateWhileLoading, createOptionPosition, formatCreateLabel, isValidNewOption, getNewOptionData, onCreateOption, options: propsOptions, onChange: propsOnChange, ...restSelectProps }: BaseCreatableProps<Option, IsMulti, Group>): PublicBaseSelectProps<Option, IsMulti, Group>;
-export {};

package/dist/types-ts4.5/use-state-manager.d.ts

@@ -1,15 +0,0 @@
-import type { PublicBaseSelectProps } from './select';
-import { type GroupBase, type PropsValue } from './types';
-type StateManagedPropKeys = 'inputValue' | 'menuIsOpen' | 'onChange' | 'onInputChange' | 'onMenuClose' | 'onMenuOpen' | 'value';
-type SelectPropsWithOptionalStateManagedProps<Option, IsMulti extends boolean, Group extends GroupBase<Option>> = Omit<PublicBaseSelectProps<Option, IsMulti, Group>, StateManagedPropKeys> & Partial<PublicBaseSelectProps<Option, IsMulti, Group>>;
-interface StateManagerAdditionalProps<Option> {
-    defaultInputValue?: string;
-    defaultMenuIsOpen?: boolean;
-    defaultValue?: PropsValue<Option>;
-}
-export type StateManagerProps<Option = unknown, IsMulti extends boolean = boolean, Group extends GroupBase<Option> = GroupBase<Option>> = SelectPropsWithOptionalStateManagedProps<Option, IsMulti, Group> & StateManagerAdditionalProps<Option>;
-/**
- * {description}.
- */
-export default function useStateManager<Option, IsMulti extends boolean, Group extends GroupBase<Option>, AdditionalProps>({ defaultInputValue, defaultMenuIsOpen, defaultValue, inputValue: propsInputValue, menuIsOpen: propsMenuIsOpen, onChange: propsOnChange, onInputChange: propsOnInputChange, onMenuClose: propsOnMenuClose, onMenuOpen: propsOnMenuOpen, value: propsValue, ...restSelectProps }: StateManagerProps<Option, IsMulti, Group> & AdditionalProps): PublicBaseSelectProps<Option, IsMulti, Group> & Omit<AdditionalProps, keyof StateManagerAdditionalProps<Option> | StateManagedPropKeys>;
-export {};