reakit
Version:
Toolkit for building accessible rich web apps with React
49 lines (48 loc) • 3.66 kB
TypeScript
import * as React from "react";
import { CompositeOptions, CompositeHTMLProps } from "../Composite/Composite";
import { unstable_ComboboxStateReturn } from "./ComboboxState";
export declare const unstable_useCombobox: {
(options?: unstable_ComboboxOptions | undefined, htmlProps?: unstable_ComboboxHTMLProps | undefined, unstable_ignoreUseOptions?: boolean | undefined): unstable_ComboboxHTMLProps;
unstable_propsAreEqual: (prev: import("..").RoleOptions & {
disabled?: boolean | undefined;
focusable?: boolean | undefined;
} & Pick<Partial<import("..").CompositeStateReturn>, "wrap" | "orientation" | "baseId" | "currentId" | "unstable_virtual" | "groups" | "unstable_moves"> & Pick<import("..").CompositeStateReturn, "move" | "first" | "last" | "items" | "setCurrentId"> & Pick<Partial<unstable_ComboboxStateReturn>, "hide" | "show" | "visible" | "inline" | "list" | "menuRole" | "minValueLength" | "currentValue" | "autoSelect" | "unstable_referenceRef"> & Pick<unstable_ComboboxStateReturn, "baseId" | "inputValue" | "setInputValue"> & {
/**
* When enabled, user can hide the combobox popover by pressing
* <kbd>Esc</kbd> while focusing on the combobox input.
* @default true
*/
hideOnEsc?: boolean | undefined;
} & React.HTMLAttributes<any> & React.RefAttributes<any> & {
wrapElement?: ((element: React.ReactNode) => React.ReactNode) | undefined;
} & {
disabled?: boolean | undefined;
} & React.InputHTMLAttributes<any>, next: import("..").RoleOptions & {
disabled?: boolean | undefined;
focusable?: boolean | undefined;
} & Pick<Partial<import("..").CompositeStateReturn>, "wrap" | "orientation" | "baseId" | "currentId" | "unstable_virtual" | "groups" | "unstable_moves"> & Pick<import("..").CompositeStateReturn, "move" | "first" | "last" | "items" | "setCurrentId"> & Pick<Partial<unstable_ComboboxStateReturn>, "hide" | "show" | "visible" | "inline" | "list" | "menuRole" | "minValueLength" | "currentValue" | "autoSelect" | "unstable_referenceRef"> & Pick<unstable_ComboboxStateReturn, "baseId" | "inputValue" | "setInputValue"> & {
/**
* When enabled, user can hide the combobox popover by pressing
* <kbd>Esc</kbd> while focusing on the combobox input.
* @default true
*/
hideOnEsc?: boolean | undefined;
} & React.HTMLAttributes<any> & React.RefAttributes<any> & {
wrapElement?: ((element: React.ReactNode) => React.ReactNode) | undefined;
} & {
disabled?: boolean | undefined;
} & React.InputHTMLAttributes<any>) => boolean;
__keys: readonly any[];
__useOptions: (options: unstable_ComboboxOptions, htmlProps: unstable_ComboboxHTMLProps) => unstable_ComboboxOptions;
};
export declare const unstable_Combobox: import("reakit-system/ts/createComponent").Component<"input", unstable_ComboboxOptions>;
export declare type unstable_ComboboxOptions = CompositeOptions & Pick<Partial<unstable_ComboboxStateReturn>, "currentValue" | "menuRole" | "list" | "inline" | "autoSelect" | "visible" | "show" | "hide" | "unstable_referenceRef" | "minValueLength"> & Pick<unstable_ComboboxStateReturn, "baseId" | "inputValue" | "setInputValue"> & {
/**
* When enabled, user can hide the combobox popover by pressing
* <kbd>Esc</kbd> while focusing on the combobox input.
* @default true
*/
hideOnEsc?: boolean;
};
export declare type unstable_ComboboxHTMLProps = CompositeHTMLProps & React.InputHTMLAttributes<any>;
export declare type unstable_ComboboxProps = unstable_ComboboxOptions & unstable_ComboboxHTMLProps;