@base-ui/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
36 lines • 1.51 kB
text/typescript
import { MenuStore, type MenuHandleStore } from "./MenuStore.mjs";
import { BasePopupHandle } from "../../utils/popups/popupHandle.mjs";
/**
* Controls a Menu imperatively and associates detached `Menu.Trigger` components with a `Menu.Root`.
* Create one with `Menu.createHandle()` and pass it to the `handle` prop of the root and of any
* triggers rendered outside of it.
*
* The imperative methods take effect only while a root using this handle is mounted; calls made
* before a root attaches (or after it unmounts) are ignored.
*/
export declare class MenuHandle<Payload> extends BasePopupHandle<MenuHandleStore<Payload>, MenuStore<Payload>> {
constructor();
/**
* Opens the menu and associates it with the trigger with the given id.
*
* This method should only be called in an event handler or an effect (not during rendering).
*
* @param triggerId ID of the trigger to associate with the menu. The trigger must be a matching
* `Menu.Trigger` with this handle passed as a prop.
*/
open(triggerId: string): void;
/**
* Closes the menu.
*
* This method should only be called in an event handler or an effect (not during rendering).
*/
close(): void;
/**
* Whether the menu is currently open. Returns `false` while no root is attached to the handle.
*/
get isOpen(): boolean;
}
/**
* Creates a new handle to connect a Menu.Root with detached Menu.Trigger components.
*/
export declare function createMenuHandle<Payload>(): MenuHandle<Payload>;