Hex Core JS
    Preparing search index...

    Type Alias ModalProps

    ModalProps: {
        backgroundClassName?: string;
        closeConfirmation?: React.ReactNode;
        confirmOnClose?: boolean;
        disableClose?: boolean;
        id?: string;
        ifRef?: React.MutableRefObject<HTMLDivElement | null>;
        onClose?: () => void;
        size?: "small" | "medium" | "large" | "full" | string & {};
        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 Modal (only relevant if the modal requests confirmation on close).

    • OptionalconfirmOnClose?: boolean

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

    • OptionaldisableClose?: boolean

      Indicates whether the modal 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 Modal.If component if used.

    • OptionalonClose?: () => void

      Callback function called when the user closes the Modal.

    • Optionalsize?: "small" | "medium" | "large" | "full" | string & {}

      Size of the modal. Modal size can either be specified using a preset size ("small" | "medium" | "large" | "full") or with CSS length units (as either one or two values, "30rem" or "30rem 40rem", where the first value refers to the height and the second to the width). Small modals fit to their content. Medium modals take a fixed size. Large modals take a fixed size but are bigger. Full modals take up the entire screen.

    • OptionalwrapperClassName?: string

      CSS class name to pass to the wrapper element.

    • OptionalzIndex?: number

      Override for CSS z-index value.

    Settings

    Member Visibility