Hex Core JS
    Preparing search index...

    Type Alias DrawerProps

    DrawerProps: {
        backgroundClassName?: string;
        closeConfirmation?: React.ReactNode;
        confirmOnClose?: boolean;
        disableClose?: boolean;
        id?: string;
        ifRef?: React.MutableRefObject<HTMLDivElement | null>;
        isModal?: boolean;
        location?: CardinalLocation;
        onClose?: () => void;
        wrapperClassName?: string;
        zIndex?: number;
    } & Partial<ClassNameProps & StyleProps & ChildrenProps>

    Type Declaration

    • OptionalbackgroundClassName?: string

      CSS class name to pass to the background element.

    • OptionalcloseConfirmation?: React.ReactNode

      Displayed content in the close confirmation Drawer (only relevant if confirmOnClose is true).

    • OptionalconfirmOnClose?: boolean

      Indicates whether the Drawer should show a confirmation message before closing (useful when the Drawer contains a form to prevent data loss).

    • OptionaldisableClose?: boolean

      Indicates whether the Drawer should not allow closing even if an onClose handler is provided.

    • Optionalid?: string

      HTML id of the element.

    • OptionalifRef?: React.MutableRefObject<HTMLDivElement | null>

      Ref prop to be provided by the Drawer.If component if used.

    • OptionalisModal?: boolean

      Decides if the drawer is a modal or not (if other content is inaccessible while the <Drawer> is open).

    • Optionallocation?: CardinalLocation

      The side of the screen on which to display the <Drawer>.

    • OptionalonClose?: () => void

      Callback function to call when the user clicks the close button or in the modal background (if there is one).

    • OptionalwrapperClassName?: string

      CSS class name to pass to the wrapper element.

    • OptionalzIndex?: number

      Override for CSS z-index value.

    Settings

    Member Visibility