@momentum-ui/react-collaboration/dist/cjs/hooks/useShouldCloseOnEsc.d.ts

Cisco Momentum UI Framework for React Collaboration Applications

/**
 * A custom React hook that manages the ability to close a component which can contain Popovers when the escape key is pressed.
 *
 * The hook listens for custom events indicating the addition or removal of tippy instances
 * that should close when Esc is pressed (e.g., instances with `hideOnEsc = true`).
 * It maintains a set of such instances and provides a `shouldCloseOnEsc` boolean that determines
 * whether the parent component should close on Esc press.
 *
 * The hook leverages two custom events defined in `Popover.events`:
 * - `EventType.TIPPY_INSTANCE_ADDED`: Indicates a new Popover instance has been added.
 * - `EventType.TIPPY_INSTANCE_REMOVED`: Indicates a Popover instance has been removed.
 *
 * Each Popover instance is expected to dispatch these events with the instance itself when it is shown and hidden.
 *
 * @returns An object containing a single property `shouldCloseOnEsc`, which is `true` if no Popover instances
 *          are currently active (i.e., all have been hidden), and `false` otherwise.
 *
 */
export declare const useShouldCloseOnEsc: () => {
    shouldCloseOnEsc: boolean;
};