Interface DrawerProps

interface DrawerProps {
    afterOpenChange?: ((open) => void);
    afterVisibleChange?: ((open) => void);
    autoFocus?: boolean;
    bodyStyle?: CSSProperties;
    children?: ReactNode;
    className?: string;
    classNames?: DrawerClassNames;
    closable?: boolean;
    closeIcon?: ReactNode;
    contentWrapperStyle?: CSSProperties;
    destroyOnClose?: boolean;
    drawerStyle?: CSSProperties;
    extra?: ReactNode;
    footer?: ReactNode;
    footerStyle?: CSSProperties;
    forceRender?: boolean;
    getContainer?: GetContainer;
    headerStyle?: CSSProperties;
    height?: string | number;
    id?: string;
    keyboard?: boolean;
    mask?: boolean;
    maskClassName?: string;
    maskClosable?: boolean;
    maskMotion?: CSSMotionProps;
    maskStyle?: CSSProperties;
    motion?: CSSMotionProps | ((placement) => CSSMotionProps);
    onClick?: MouseEventHandler<HTMLDivElement>;
    onClose?: ((e) => void);
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
    onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
    onMouseEnter?: MouseEventHandler<HTMLDivElement>;
    onMouseLeave?: MouseEventHandler<HTMLDivElement>;
    onMouseOver?: MouseEventHandler<HTMLDivElement>;
    open?: boolean;
    panelRef?: Ref<HTMLDivElement>;
    placement?: Placement;
    prefixCls?: string;
    push?: boolean | PushConfig;
    rootClassName?: string;
    rootStyle?: CSSProperties;
    size?: "default" | "large";
    style?: CSSProperties;
    styles?: DrawerStyles;
    title?: ReactNode;
    visible?: boolean;
    width?: string | number;
    zIndex?: number;
}

Hierarchy

  • Omit<RcDrawerProps, "maskStyle">
  • Omit<DrawerPanelProps, "prefixCls">
    • DrawerProps

Properties

afterOpenChange? afterVisibleChange? autoFocus? bodyStyle? children? className? classNames? closable? closeIcon? contentWrapperStyle? destroyOnClose? drawerStyle? extra? footer? footerStyle? forceRender? getContainer? headerStyle? height? id? keyboard? mask? maskClassName? maskClosable? maskMotion? maskStyle? motion? onClick? onClose? onKeyDown? onKeyUp? onMouseEnter? onMouseLeave? onMouseOver? open? panelRef? placement? prefixCls? push? rootClassName? rootStyle? size? style? styles? title? visible? width? zIndex?

Properties

Optional afterOpenChange

afterOpenChange?: ((open) => void)

Type declaration

    • (open): void

    • Parameters

      • open: boolean

      Returns void

Optional afterVisibleChange

afterVisibleChange?: ((open) => void)

Type declaration

    • (open): void

    • Parameters

      • open: boolean

      Returns void

      Deprecated

      Please use afterOpenChange instead

Deprecated

Please use afterOpenChange instead

Optional autoFocus

autoFocus?: boolean

Optional bodyStyle

bodyStyle?: CSSProperties

Deprecated

Please use styles.body instead

Optional children

children?: ReactNode

Optional className

className?: string

Optional classNames

classNames?: DrawerClassNames

Optional closable

closable?: boolean

Recommend to use closeIcon instead

e.g.

<Drawer closeIcon={false} />

Optional closeIcon

closeIcon?: ReactNode

Optional contentWrapperStyle

contentWrapperStyle?: CSSProperties

Deprecated

Please use styles.wrapper instead

Optional destroyOnClose

destroyOnClose?: boolean

Optional drawerStyle

drawerStyle?: CSSProperties

Deprecated

Please use styles.content instead

Optional extra

extra?: ReactNode

Optional footer

footer?: ReactNode

Optional footerStyle

footerStyle?: CSSProperties

Deprecated

Please use styles.footer instead

Optional forceRender

forceRender?: boolean

Optional getContainer

getContainer?: GetContainer

Optional headerStyle

headerStyle?: CSSProperties

Deprecated

Please use styles.header instead

Optional height

height?: string | number

Optional id

id?: string

Optional keyboard

keyboard?: boolean

Optional mask

mask?: boolean

Optional maskClassName

maskClassName?: string

Optional maskClosable

maskClosable?: boolean

Optional maskMotion

maskMotion?: CSSMotionProps

Optional maskStyle

maskStyle?: CSSProperties

Deprecated

Please use styles.mask instead

Optional motion

motion?: CSSMotionProps | ((placement) => CSSMotionProps)

Type declaration

    • (placement): CSSMotionProps

    • Parameters

      • placement: Placement

      Returns CSSMotionProps

Optional onClick

onClick?: MouseEventHandler<HTMLDivElement>

Optional onClose

onClose?: ((e) => void)

Type declaration

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLDivElement>

Optional onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLDivElement>

Optional onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLDivElement>

Optional onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLDivElement>

Optional onMouseOver

onMouseOver?: MouseEventHandler<HTMLDivElement>

Optional open

open?: boolean

Optional panelRef

panelRef?: Ref<HTMLDivElement>

Optional placement

placement?: Placement

Optional prefixCls

prefixCls?: string

Optional push

push?: boolean | PushConfig

Optional rootClassName

rootClassName?: string

Optional rootStyle

rootStyle?: CSSProperties

Optional size

size?: "default" | "large"

Optional style

style?: CSSProperties

Optional styles

styles?: DrawerStyles

Optional title

title?: ReactNode

Optional visible

visible?: boolean

Deprecated

Please use open instead

Optional width

width?: string | number

Optional zIndex

zIndex?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc