Skip to content

DrawerProps

type DrawerProps = PaddingProps &
TypographyProps &
ColorProps &
LayoutProps &
CustomChakraBoxProps &
ChakraDrawerProperties & {
closeOnEsc?: boolean;
closeOnOverlayClick?: boolean;
isInline?: boolean;
isOpen?: boolean;
onClose?: () => void;
placement?: ChakraDrawerProps["placement"] | "left" | "right";
size?: "xs" | "sm" | "md" | "lg" | "xl" | "full";
zIndex?: number;
};
Name Type Description
closeOnEsc? boolean -
closeOnOverlayClick? boolean -
isInline? boolean When true, the drawer is placed inline in the document flow instead of as a fixed overlay. This means that the drawer will not cover the entire screen and will be placed in the normal document flow. Note: Not all drawer properties support inline mode (e.g. placement, closeOnOverlayClick or size “full”). Defaults to false.
isOpen? boolean -
onClose()? () => void -
placement? ChakraDrawerProps["placement"] | "left" | "right" -
size? "xs" | "sm" | "md" | "lg" | "xl" | "full" The size of the drawer. Defaults to xs.
zIndex? number z-index applied to Drawer. Only applicable when isInline is true. Defaults to 1.