@yamada-ui/react/dist/types/components/drawer/use-drawer.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { SimplePlacement } from "../../core/system/index.types.js";
import { PropGetter } from "../../core/components/index.types.js";
import "../../core/index.js";
import { HTMLMotionProps } from "../motion/index.types.js";
import { UseModalProps } from "../modal/use-modal.js";

//#region src/components/drawer/use-drawer.d.ts
interface UseDrawerProps extends UseModalProps {
  /**
   * If `true`, then the drawer will close on drag.
   *
   * @default false
   */
  closeOnDrag?: boolean;
  /**
   * Applies constraints on the permitted draggable area.
   *
   * @default 0
   */
  dragConstraints?: number;
  /**
   * The degree of movement allowed outside constraints. 0 = no movement, 1 = full movement.
   *
   * @default 0.1
   */
  dragElastic?: number;
  /**
   * Offset from being dragged to closing.
   *
   * @default 80
   */
  dragOffset?: number;
  /**
   * Velocity of the drag that triggers close.
   *
   * @default 100
   */
  dragVelocity?: number;
  /**
   * The placement of the drawer.
   *
   * @default 'inline-end'
   */
  placement?: SimplePlacement;
}
declare const useDrawer: ({
  closeOnDrag,
  closeOnEsc,
  closeOnOverlay,
  dragConstraints,
  dragElastic,
  dragOffset,
  dragVelocity,
  placement,
  onEsc,
  ...rest
}?: UseDrawerProps) => {
  closeOnDrag: boolean;
  getContentProps: PropGetter<HTMLMotionProps<"section">, undefined, undefined>;
  getDragBarProps: PropGetter<"div", undefined, undefined>;
  onClose: () => void | Promise<void>;
  open: boolean;
  getBodyProps: PropGetter<"div", undefined, undefined>;
  getCloseButtonProps: PropGetter<"button", undefined, undefined>;
  getCloseTriggerProps: PropGetter<"button", undefined, undefined>;
  getFooterProps: PropGetter<"footer", undefined, undefined>;
  getHeaderProps: PropGetter<"header", undefined, undefined>;
  getOpenTriggerProps: PropGetter<"button", undefined, undefined>;
  getOverlayProps: PropGetter<"div", undefined, undefined>;
  getRootProps: PropGetter<"div", undefined, undefined>;
  getTitleProps: PropGetter<"h2", undefined, undefined>;
  onOpen: () => void | Promise<void>;
};
type UseDrawerReturn = ReturnType<typeof useDrawer>;
//#endregion
export { UseDrawerProps, UseDrawerReturn, useDrawer };
//# sourceMappingURL=use-drawer.d.ts.map