UNPKG

@intility/bifrost-react

Version:

React library for Intility's design system, Bifrost.

37 lines (36 loc) 1.28 kB
import type { PropsFor } from "../../types.js"; export type DrawerProps = PropsFor<"div", { /** Drawer title */ header?: React.ReactNode; /** Fixed (non-scrollable) footer content */ footer?: React.ReactNode; /** Open or closed state */ isOpen: boolean; /** Force overlay on or off (default on for small screens) */ overlay?: boolean; /** Disables the FocusTrap (Can create issues in combination with Modal for * instance) component in the drawer */ disableFocusTrap?: boolean; /** Drawer position, `right` (default) or `bottom` */ position?: "right" | "bottom"; /** Remove default padding */ noPadding?: boolean; /** Function for closing the Drawer */ onRequestClose?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent> | React.MouseEvent<HTMLDivElement, MouseEvent> | KeyboardEvent) => void; }>; /** * Hideable right-hand sidebar * * @see https://bifrost.intility.com/react/drawer * * @example * <Drawer * header="Drawer header" * isOpen={openState} * onRequestClose={() => setOpenState(false)} * > * <p>Drawer content</p> * </Drawer> */ declare const Drawer: import("react").ForwardRefExoticComponent<DrawerProps & import("react").RefAttributes<HTMLDivElement>>; export default Drawer;