@yamada-ui/autocomplete 1.5.1 → 1.5.2-dev-20240917033401

package/dist/use-autocomplete-option.mjs

@@ -0,0 +1,13 @@
+"use client"
+import {
+  useAutocompleteCreate,
+  useAutocompleteEmpty,
+  useAutocompleteOption
+} from "./chunk-PRDD3JJO.mjs";
+import "./chunk-JPUKYLBW.mjs";
+export {
+  useAutocompleteCreate,
+  useAutocompleteEmpty,
+  useAutocompleteOption
+};
+//# sourceMappingURL=use-autocomplete-option.mjs.map

package/dist/use-autocomplete-option.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/use-autocomplete.d.mts

@@ -1,8 +1,188 @@
-import '@yamada-ui/core';
-import 'react/jsx-runtime';
-import 'react';
-import '@yamada-ui/use-descendant';
-import '@yamada-ui/form-control';
-import '@yamada-ui/popover';
-import '@yamada-ui/utils';
-export { d as AutocompleteDescendantsContextProvider, b as AutocompleteItem, g as AutocompleteProvider, t as UseAutocompleteCreateReturn, w as UseAutocompleteEmptyReturn, l as UseAutocompleteInputReturn, U as UseAutocompleteOptionGroupProps, o as UseAutocompleteOptionGroupReturn, p as UseAutocompleteOptionProps, r as UseAutocompleteOptionReturn, c as UseAutocompleteProps, j as UseAutocompleteReturn, i as useAutocomplete, h as useAutocompleteContext, s as useAutocompleteCreate, f as useAutocompleteDescendant, e as useAutocompleteDescendants, u as useAutocompleteDescendantsContext, v as useAutocompleteEmpty, k as useAutocompleteInput, m as useAutocompleteList, q as useAutocompleteOption, n as useAutocompleteOptionGroup } from './use-autocomplete-BJNWa6hL.mjs';
+import * as _yamada_ui_core from '@yamada-ui/core';
+import { HTMLUIProps, PropGetter } from '@yamada-ui/core';
+import * as react from 'react';
+import { FocusEvent, ChangeEvent, MouseEvent, DOMAttributes } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as _yamada_ui_use_descendant from '@yamada-ui/use-descendant';
+import { FormControlOptions } from '@yamada-ui/form-control';
+import { PopoverProps, ComboBoxProps } from '@yamada-ui/popover';
+import { Union } from '@yamada-ui/utils';
+import { AutocompleteOptionProps } from './autocomplete-option.mjs';
+import { AutocompleteOptionGroupProps } from './autocomplete-option-group.mjs';
+import './use-autocomplete-option.mjs';
+import './use-autocomplete-option-group.mjs';
+
+interface ChangeOptions {
+    forceUpdate?: boolean;
+    runOmit?: boolean;
+    runRebirth?: boolean;
+}
+interface AutocompleteItemWithValue extends AutocompleteOptionProps {
+    label?: string;
+    value?: string;
+}
+interface AutocompleteItemWithItems extends AutocompleteOptionGroupProps, Pick<AutocompleteOptionProps, "isDisabled" | "isFocusable"> {
+    items?: AutocompleteItemWithValue[];
+}
+type AutocompleteItem = AutocompleteItemWithValue | AutocompleteItemWithItems;
+type UseAutocompleteBaseProps<T extends string | string[] = string> = ComboBoxProps & FormControlOptions & {
+    /**
+     * The value of the autocomplete.
+     */
+    value?: T;
+    /**
+     * The initial value of the autocomplete.
+     */
+    defaultValue?: T;
+    /**
+     * The callback invoked when value state changes.
+     */
+    onChange?: (value: T) => void;
+    /**
+     * The callback invoked when search input.
+     */
+    onSearch?: (ev: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * The callback invoked when autocomplete option created.
+     */
+    onCreate?: (newItem: AutocompleteItem, newItems: AutocompleteItem[]) => void;
+    /**
+     * Function to format text when search input.
+     */
+    format?: (value: string) => string;
+    /**
+     * The position to be inserted when the autocomplete option is created.
+     *
+     * @default 'first'
+     */
+    insertPositionItem?: Union<"first" | "last"> | [string, "first" | "last"];
+    /**
+     * If `true`, the list element will be closed when value is selected.
+     *
+     * @default true
+     */
+    closeOnSelect?: boolean;
+    /**
+     * The message displayed when the search yields no hits.
+     *
+     * @default 'No results found'
+     */
+    emptyMessage?: string;
+    /**
+     * If `true`, enables the creation of autocomplete option.
+     *
+     * @default false
+     */
+    allowCreate?: boolean;
+    /**
+     * If `true`, enables the free input.
+     */
+    allowFree?: boolean;
+    /**
+     * If `true`, the selected item(s) will be excluded from the list.
+     *
+     * @default false
+     */
+    omitSelectedValues?: boolean;
+    /**
+     * The maximum selectable value.
+     */
+    maxSelectValues?: number;
+    /**
+     * Props for select option element.
+     */
+    optionProps?: Omit<AutocompleteOptionProps, "value" | "children">;
+    /**
+     * If provided, generate options based on items.
+     */
+    items?: AutocompleteItem[];
+};
+type UseAutocompleteProps<T extends string | string[] = string> = Omit<HTMLUIProps<"input">, keyof UseAutocompleteBaseProps | "list" | "disabled" | "required" | "readOnly" | "size"> & UseAutocompleteBaseProps<T>;
+declare const useAutocomplete: <T extends string | string[] = string>(props: UseAutocompleteProps<T>) => {
+    id: string | undefined;
+    descendants: {
+        register: (nodeOrOptions: HTMLElement | {
+            disabled?: boolean;
+            id?: string;
+            filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined;
+        } | null) => void | ((node: HTMLElement | null) => void);
+        unregister: (node: HTMLElement) => void;
+        destroy: () => void;
+        count: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        values: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}>[];
+        value: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        indexOf: (node: HTMLElement | null) => number;
+        firstValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        lastValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        prevValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        nextValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledCount: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        enabledValues: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}>[];
+        enabledValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledIndexOf: (node: HTMLElement | null, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        enabledFirstValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledLastValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledPrevValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledNextValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+    };
+    value: T;
+    label: T | undefined;
+    inputValue: string;
+    isHit: boolean;
+    isEmpty: boolean;
+    computedChildren: (react_jsx_runtime.JSX.Element | undefined)[] | undefined;
+    focusedIndex: number;
+    omitSelectedValues: boolean;
+    closeOnSelect: boolean;
+    allowCreate: boolean;
+    allowFree: boolean;
+    emptyMessage: string;
+    isOpen: boolean;
+    isAllSelected: boolean;
+    listRef: react.RefObject<HTMLUListElement>;
+    inputRef: react.RefObject<HTMLInputElement>;
+    optionProps: Omit<AutocompleteOptionProps, "value" | "children"> | undefined;
+    formControlProps: {
+        disabled: boolean | undefined;
+        _invalid?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _hover?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _active?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _focus?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _focusVisible?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        readOnly: boolean | undefined;
+        required: boolean | undefined;
+        "aria-disabled": boolean | undefined;
+        "aria-invalid": boolean | undefined;
+        "aria-required": boolean | undefined;
+        onBlur: (event: FocusEvent<HTMLInputElement, Element>) => void;
+        "data-readonly": boolean | "false" | "true";
+    };
+    setFocusedIndex: react.Dispatch<react.SetStateAction<number>>;
+    onChangeLabel: (newValue: string, { forceUpdate, runOmit }?: ChangeOptions) => void;
+    onChange: (newValue: string, { forceUpdate, runRebirth }?: ChangeOptions) => void;
+    onSearch: (ev: ChangeEvent<HTMLInputElement>) => void;
+    onCreate: () => void;
+    onClear: (ev: MouseEvent<HTMLDivElement>) => void;
+    onCompositionStart: () => void;
+    onCompositionEnd: () => void;
+    pickOptions: (value: string) => void;
+    rebirthOptions: (runFocus?: boolean) => void;
+    onOpen: () => void;
+    onClose: () => void;
+    onFocusFirst: () => void;
+    onFocusLast: () => void;
+    onFocusSelected: () => void;
+    onFocusNext: (index?: number) => void;
+    onFocusPrev: (index?: number) => void;
+    getPopoverProps: (props?: PopoverProps) => PopoverProps;
+    getContainerProps: PropGetter<"div", undefined>;
+    getFieldProps: PropGetter<"div", undefined>;
+    inputProps: DOMAttributes<HTMLInputElement>;
+};
+type UseAutocompleteReturn = ReturnType<typeof useAutocomplete>;
+declare const useAutocompleteInput: () => {
+    getInputProps: PropGetter<"input", undefined>;
+};
+type UseAutocompleteInputReturn = ReturnType<typeof useAutocompleteInput>;
+
+export { type AutocompleteItem, type ChangeOptions, type UseAutocompleteInputReturn, type UseAutocompleteProps, type UseAutocompleteReturn, useAutocomplete, useAutocompleteInput };

package/dist/use-autocomplete.d.ts

@@ -1,8 +1,188 @@
-import '@yamada-ui/core';
-import 'react/jsx-runtime';
-import 'react';
-import '@yamada-ui/use-descendant';
-import '@yamada-ui/form-control';
-import '@yamada-ui/popover';
-import '@yamada-ui/utils';
-export { d as AutocompleteDescendantsContextProvider, b as AutocompleteItem, g as AutocompleteProvider, t as UseAutocompleteCreateReturn, w as UseAutocompleteEmptyReturn, l as UseAutocompleteInputReturn, U as UseAutocompleteOptionGroupProps, o as UseAutocompleteOptionGroupReturn, p as UseAutocompleteOptionProps, r as UseAutocompleteOptionReturn, c as UseAutocompleteProps, j as UseAutocompleteReturn, i as useAutocomplete, h as useAutocompleteContext, s as useAutocompleteCreate, f as useAutocompleteDescendant, e as useAutocompleteDescendants, u as useAutocompleteDescendantsContext, v as useAutocompleteEmpty, k as useAutocompleteInput, m as useAutocompleteList, q as useAutocompleteOption, n as useAutocompleteOptionGroup } from './use-autocomplete-BJNWa6hL.js';
+import * as _yamada_ui_core from '@yamada-ui/core';
+import { HTMLUIProps, PropGetter } from '@yamada-ui/core';
+import * as react from 'react';
+import { FocusEvent, ChangeEvent, MouseEvent, DOMAttributes } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as _yamada_ui_use_descendant from '@yamada-ui/use-descendant';
+import { FormControlOptions } from '@yamada-ui/form-control';
+import { PopoverProps, ComboBoxProps } from '@yamada-ui/popover';
+import { Union } from '@yamada-ui/utils';
+import { AutocompleteOptionProps } from './autocomplete-option.js';
+import { AutocompleteOptionGroupProps } from './autocomplete-option-group.js';
+import './use-autocomplete-option.js';
+import './use-autocomplete-option-group.js';
+
+interface ChangeOptions {
+    forceUpdate?: boolean;
+    runOmit?: boolean;
+    runRebirth?: boolean;
+}
+interface AutocompleteItemWithValue extends AutocompleteOptionProps {
+    label?: string;
+    value?: string;
+}
+interface AutocompleteItemWithItems extends AutocompleteOptionGroupProps, Pick<AutocompleteOptionProps, "isDisabled" | "isFocusable"> {
+    items?: AutocompleteItemWithValue[];
+}
+type AutocompleteItem = AutocompleteItemWithValue | AutocompleteItemWithItems;
+type UseAutocompleteBaseProps<T extends string | string[] = string> = ComboBoxProps & FormControlOptions & {
+    /**
+     * The value of the autocomplete.
+     */
+    value?: T;
+    /**
+     * The initial value of the autocomplete.
+     */
+    defaultValue?: T;
+    /**
+     * The callback invoked when value state changes.
+     */
+    onChange?: (value: T) => void;
+    /**
+     * The callback invoked when search input.
+     */
+    onSearch?: (ev: ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * The callback invoked when autocomplete option created.
+     */
+    onCreate?: (newItem: AutocompleteItem, newItems: AutocompleteItem[]) => void;
+    /**
+     * Function to format text when search input.
+     */
+    format?: (value: string) => string;
+    /**
+     * The position to be inserted when the autocomplete option is created.
+     *
+     * @default 'first'
+     */
+    insertPositionItem?: Union<"first" | "last"> | [string, "first" | "last"];
+    /**
+     * If `true`, the list element will be closed when value is selected.
+     *
+     * @default true
+     */
+    closeOnSelect?: boolean;
+    /**
+     * The message displayed when the search yields no hits.
+     *
+     * @default 'No results found'
+     */
+    emptyMessage?: string;
+    /**
+     * If `true`, enables the creation of autocomplete option.
+     *
+     * @default false
+     */
+    allowCreate?: boolean;
+    /**
+     * If `true`, enables the free input.
+     */
+    allowFree?: boolean;
+    /**
+     * If `true`, the selected item(s) will be excluded from the list.
+     *
+     * @default false
+     */
+    omitSelectedValues?: boolean;
+    /**
+     * The maximum selectable value.
+     */
+    maxSelectValues?: number;
+    /**
+     * Props for select option element.
+     */
+    optionProps?: Omit<AutocompleteOptionProps, "value" | "children">;
+    /**
+     * If provided, generate options based on items.
+     */
+    items?: AutocompleteItem[];
+};
+type UseAutocompleteProps<T extends string | string[] = string> = Omit<HTMLUIProps<"input">, keyof UseAutocompleteBaseProps | "list" | "disabled" | "required" | "readOnly" | "size"> & UseAutocompleteBaseProps<T>;
+declare const useAutocomplete: <T extends string | string[] = string>(props: UseAutocompleteProps<T>) => {
+    id: string | undefined;
+    descendants: {
+        register: (nodeOrOptions: HTMLElement | {
+            disabled?: boolean;
+            id?: string;
+            filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined;
+        } | null) => void | ((node: HTMLElement | null) => void);
+        unregister: (node: HTMLElement) => void;
+        destroy: () => void;
+        count: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        values: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}>[];
+        value: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        indexOf: (node: HTMLElement | null) => number;
+        firstValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        lastValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        prevValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        nextValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledCount: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        enabledValues: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}>[];
+        enabledValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledIndexOf: (node: HTMLElement | null, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => number;
+        enabledFirstValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledLastValue: (filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledPrevValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+        enabledNextValue: (index: number, filter?: _yamada_ui_use_descendant.FilterDescendant<HTMLElement, {}> | undefined, loop?: boolean) => _yamada_ui_use_descendant.Descendant<HTMLElement, {}> | undefined;
+    };
+    value: T;
+    label: T | undefined;
+    inputValue: string;
+    isHit: boolean;
+    isEmpty: boolean;
+    computedChildren: (react_jsx_runtime.JSX.Element | undefined)[] | undefined;
+    focusedIndex: number;
+    omitSelectedValues: boolean;
+    closeOnSelect: boolean;
+    allowCreate: boolean;
+    allowFree: boolean;
+    emptyMessage: string;
+    isOpen: boolean;
+    isAllSelected: boolean;
+    listRef: react.RefObject<HTMLUListElement>;
+    inputRef: react.RefObject<HTMLInputElement>;
+    optionProps: Omit<AutocompleteOptionProps, "value" | "children"> | undefined;
+    formControlProps: {
+        disabled: boolean | undefined;
+        _invalid?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _hover?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _active?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _focus?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        _focusVisible?: ({} & _yamada_ui_core.CSSUIObject) | undefined;
+        readOnly: boolean | undefined;
+        required: boolean | undefined;
+        "aria-disabled": boolean | undefined;
+        "aria-invalid": boolean | undefined;
+        "aria-required": boolean | undefined;
+        onBlur: (event: FocusEvent<HTMLInputElement, Element>) => void;
+        "data-readonly": boolean | "false" | "true";
+    };
+    setFocusedIndex: react.Dispatch<react.SetStateAction<number>>;
+    onChangeLabel: (newValue: string, { forceUpdate, runOmit }?: ChangeOptions) => void;
+    onChange: (newValue: string, { forceUpdate, runRebirth }?: ChangeOptions) => void;
+    onSearch: (ev: ChangeEvent<HTMLInputElement>) => void;
+    onCreate: () => void;
+    onClear: (ev: MouseEvent<HTMLDivElement>) => void;
+    onCompositionStart: () => void;
+    onCompositionEnd: () => void;
+    pickOptions: (value: string) => void;
+    rebirthOptions: (runFocus?: boolean) => void;
+    onOpen: () => void;
+    onClose: () => void;
+    onFocusFirst: () => void;
+    onFocusLast: () => void;
+    onFocusSelected: () => void;
+    onFocusNext: (index?: number) => void;
+    onFocusPrev: (index?: number) => void;
+    getPopoverProps: (props?: PopoverProps) => PopoverProps;
+    getContainerProps: PropGetter<"div", undefined>;
+    getFieldProps: PropGetter<"div", undefined>;
+    inputProps: DOMAttributes<HTMLInputElement>;
+};
+type UseAutocompleteReturn = ReturnType<typeof useAutocomplete>;
+declare const useAutocompleteInput: () => {
+    getInputProps: PropGetter<"input", undefined>;
+};
+type UseAutocompleteInputReturn = ReturnType<typeof useAutocompleteInput>;
+
+export { type AutocompleteItem, type ChangeOptions, type UseAutocompleteInputReturn, type UseAutocompleteProps, type UseAutocompleteReturn, useAutocomplete, useAutocompleteInput };