@base-ui-components/react/esm/composite/root/CompositeRootContext.d.ts

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.

import * as React from 'react';
export interface CompositeRootContext {
  highlightedIndex: number;
  onHighlightedIndexChange: (index: number, shouldScrollIntoView?: boolean) => void;
  highlightItemOnHover: boolean;
  /**
   * Makes it possible to control composite components using events that don't originate from their children.
   * For example, a Menubar with detached triggers may define its Menu.Root outside of CompositeRoot.
   * Keyboard events that occur within this menu won't normally be captured by the CompositeRoot,
   * so they need to be forwarded manually using this function.
   */
  relayKeyboardEvent: (event: React.KeyboardEvent<any>) => void;
}
export declare const CompositeRootContext: React.Context<CompositeRootContext | undefined>;
export declare function useCompositeRootContext(optional: true): CompositeRootContext | undefined;
export declare function useCompositeRootContext(optional?: false): CompositeRootContext;