@base-ui/react/drawer/trigger/DrawerTrigger.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 type * as React from 'react';
import type { DialogHandle as DrawerHandle } from "../../dialog/store/DialogHandle.js";
import type { BaseUIComponentProps, NativeButtonProps } from "../../utils/types.js";
/**
 * A button that opens the drawer.
 * Renders a `<button>` element.
 *
 * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
 */
export declare const DrawerTrigger: DrawerTrigger;
export interface DrawerTrigger {
  <Payload>(componentProps: DrawerTriggerProps<Payload> & React.RefAttributes<HTMLElement>): React.JSX.Element;
}
export interface DrawerTriggerProps<Payload = unknown> extends NativeButtonProps, BaseUIComponentProps<'button', DrawerTrigger.State> {
  /**
   * A handle to associate the trigger with a drawer.
   * Can be created with the Drawer.createHandle() method.
   */
  handle?: DrawerHandle<Payload> | undefined;
  /**
   * A payload to pass to the drawer when it is opened.
   */
  payload?: Payload | undefined;
  /**
   * ID of the trigger. In addition to being forwarded to the rendered element,
   * it is also used to specify the active trigger for drawers in controlled mode (with the Drawer.Root `triggerId` prop).
   */
  id?: string | undefined;
}
export interface DrawerTriggerState {
  /**
   * Whether the drawer is currently disabled.
   */
  disabled: boolean;
  /**
   * Whether the drawer is currently open.
   */
  open: boolean;
}
export declare namespace DrawerTrigger {
  type Props<Payload = unknown> = DrawerTriggerProps<Payload>;
  type State = DrawerTriggerState;
}