@mui/base/useList/listActions.types.d.ts

A library of headless ('unstyled') React UI components and low-level hooks.

/// <reference types="react" />
export declare const ListActionTypes: {
    readonly blur: "list:blur";
    readonly focus: "list:focus";
    readonly keyDown: "list:keyDown";
    readonly itemClick: "list:itemClick";
    readonly itemHover: "list:itemHover";
    readonly itemsChange: "list:itemsChange";
    readonly textNavigation: "list:textNavigation";
};
interface ItemClickAction<ItemValue> {
    type: typeof ListActionTypes.itemClick;
    item: ItemValue;
    event: React.MouseEvent;
}
interface ItemHoverAction<ItemValue> {
    type: typeof ListActionTypes.itemHover;
    item: ItemValue;
    event: React.MouseEvent;
}
interface FocusAction {
    type: typeof ListActionTypes.focus;
    event: React.FocusEvent;
}
interface BlurAction {
    type: typeof ListActionTypes.blur;
    event: React.FocusEvent;
}
interface KeyDownAction {
    type: typeof ListActionTypes.keyDown;
    key: string;
    event: React.KeyboardEvent;
}
interface TextNavigationAction {
    type: typeof ListActionTypes.textNavigation;
    event: React.KeyboardEvent;
    searchString: string;
}
interface ItemsChangeAction<ItemValue> {
    type: typeof ListActionTypes.itemsChange;
    event: null;
    items: ItemValue[];
    previousItems: ItemValue[];
}
/**
 * A union of all standard actions that can be dispatched to the list reducer.
 */
export type ListAction<ItemValue> = BlurAction | FocusAction | ItemClickAction<ItemValue> | ItemHoverAction<ItemValue> | ItemsChangeAction<ItemValue> | KeyDownAction | TextNavigationAction;
export {};