@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
91 lines • 3.66 kB
TypeScript
/**
* Opens a `Combobox` with the up/down arrow keys. This should be used only on a
* {@link ComboboxInput Combobox.Input}. It adds a keydown listener for the up/down arrow keys.
*/
export declare const useComboboxInputOpenWithArrowKeys: import("@workday/canvas-kit-react/common").BehaviorHook<{
state: {
stackRef: import("react").RefObject<HTMLDivElement>;
targetRef: import("react").RefObject<HTMLButtonElement>;
initialFocusRef: import("react").RefObject<any> | undefined;
returnFocusRef: import("react").RefObject<any> | undefined;
placement: import("@popperjs/core").Placement;
id: string;
visibility: "hidden" | "visible";
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: import("react").MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: import("react").RefObject<HTMLDivElement>;
orientation: "horizontal" | "vertical";
indexRef: import("react").MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: import("../../..").Item<any>[];
mode: "multiple" | "single";
value: string | undefined;
inputRef: import("react").RefObject<HTMLInputElement>;
width: number;
};
events: {
setWidth(width: number): void;
updatePlacement(data: {
placement: import("@popperjs/core").Placement;
}): void;
show(event?: Event | import("react").SyntheticEvent<Element, Event> | undefined): void;
hide(event?: Event | import("react").SyntheticEvent<Element, Event> | undefined): void;
select(data: {
id: string;
}): void;
selectAll(): void;
unselectAll(): void;
setSelectedIds(ids: string[] | "all"): void;
remove(data: {
id: string;
nextId?: string | undefined;
event?: Event | import("react").SyntheticEvent<Element, Event> | undefined;
}): void;
goTo(data: {
id: string;
}): void;
goToNext(): void;
goToPrevious(): void;
goToPreviousRow(): void;
goToNextRow(): void;
goToFirst(): void;
goToLast(): void;
goToFirstOfRow(): void;
goToLastOfRow(): void;
goToNextPage(): void;
goToPreviousPage(): void;
registerItem(data: {
id: string;
textValue: string;
}): void;
unregisterItem(data: {
id: string;
}): void;
updateItemHeight(data: {
value: number;
}): void;
};
onFilterChange: (event: import("react").ChangeEvent<HTMLInputElement>) => void;
onChange: (event: import("react").ChangeEvent<HTMLInputElement>) => void;
selection: import("../../..").SelectionManager;
navigation: import("../../..").NavigationManager;
getId: (item: any) => string;
}, {
readonly onKeyDown: (event: React.KeyboardEvent) => void;
}>;
//# sourceMappingURL=useComboboxInputOpenWithArrowKeys.d.ts.map