Interface ModalProps

interface ModalProps {
    afterClose?: (() => void);
    afterOpenChange?: ((open) => void);
    bodyStyle?: CSSProperties;
    cancelButtonProps?: Antd.ButtonProps;
    cancelText?: ReactNode;
    centered?: boolean;
    children?: ReactNode;
    className?: string;
    classNames?: ModalClassNames;
    closable?: boolean;
    closeIcon?: ReactNode;
    confirmLoading?: boolean;
    destroyOnClose?: boolean;
    focusTriggerAfterClose?: boolean;
    footer?: ReactNode | ModalFooterRender;
    forceRender?: boolean;
    getContainer?: string | false | HTMLElement | getContainerFunc;
    keyboard?: boolean;
    mask?: boolean;
    maskClosable?: boolean;
    maskStyle?: CSSProperties;
    maskTransitionName?: string;
    modalRender?: ((node) => ReactNode);
    mousePosition?: MousePosition;
    okButtonProps?: Antd.ButtonProps;
    okText?: ReactNode;
    okType?: LegacyButtonType;
    onCancel?: ((e) => void);
    onOk?: ((e) => void);
    open?: boolean;
    prefixCls?: string;
    rootClassName?: string;
    style?: CSSProperties;
    styles?: Omit<ModalStyles, "wrapper">;
    title?: ReactNode;
    transitionName?: string;
    visible?: boolean;
    width?: string | number;
    wrapClassName?: string;
    wrapProps?: any;
    zIndex?: number;
}

Hierarchy

  • ModalCommonProps
    • ModalProps

Properties

afterClose? afterOpenChange? bodyStyle? cancelButtonProps? cancelText? centered? children? className? classNames? closable? closeIcon? confirmLoading? destroyOnClose? focusTriggerAfterClose? footer? forceRender? getContainer? keyboard? mask? maskClosable? maskStyle? maskTransitionName? modalRender? mousePosition? okButtonProps? okText? okType? onCancel? onOk? open? prefixCls? rootClassName? style? styles? title? transitionName? visible? width? wrapClassName? wrapProps? zIndex?

Properties

Optional afterClose

afterClose?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional afterOpenChange

afterOpenChange?: ((open) => void)

Callback when the animation ends when Modal is turned on and off

Type declaration

    • (open): void

    • Callback when the animation ends when Modal is turned on and off

      Parameters

      • open: boolean

      Returns void

Optional bodyStyle

bodyStyle?: CSSProperties

Deprecated

Please use styles.body instead

Optional cancelButtonProps

cancelButtonProps?: Antd.ButtonProps

Optional cancelText

cancelText?: ReactNode

Text of the Cancel button

Optional centered

centered?: boolean

Centered Modal

Optional children

children?: ReactNode

Optional className

className?: string

Optional classNames

classNames?: ModalClassNames

Optional closable

closable?: boolean

Whether a close (x) button is visible on top right of the modal dialog or not. Recommend to use closeIcon instead.

Optional closeIcon

closeIcon?: ReactNode

Optional confirmLoading

confirmLoading?: boolean

Whether to apply loading visual effect for OK button or not

Optional destroyOnClose

destroyOnClose?: boolean

Optional focusTriggerAfterClose

focusTriggerAfterClose?: boolean

Optional footer

footer?: ReactNode | ModalFooterRender

Footer content

Optional forceRender

forceRender?: boolean

Force render Modal

Optional getContainer

getContainer?: string | false | HTMLElement | getContainerFunc

Optional keyboard

keyboard?: boolean

Optional mask

mask?: boolean

Optional maskClosable

maskClosable?: boolean

Whether to close the modal dialog when the mask (area outside the modal) is clicked

Optional maskStyle

maskStyle?: CSSProperties

Deprecated

Please use styles.mask instead

Optional maskTransitionName

maskTransitionName?: string

Optional modalRender

modalRender?: ((node) => ReactNode)

Type declaration

    • (node): ReactNode

    • Parameters

      • node: ReactNode

      Returns ReactNode

Optional mousePosition

mousePosition?: MousePosition

Optional okButtonProps

okButtonProps?: Antd.ButtonProps

Optional okText

okText?: ReactNode

Text of the OK button

Optional okType

okType?: LegacyButtonType

Button type of the OK button

Optional onCancel

onCancel?: ((e) => void)

Specify a function that will be called when a user clicks mask, close button on top right or Cancel button

Type declaration

    • (e): void

    • Specify a function that will be called when a user clicks mask, close button on top right or Cancel button

      Parameters

      Returns void

Optional onOk

onOk?: ((e) => void)

Specify a function that will be called when a user clicks the OK button

Type declaration

    • (e): void

    • Specify a function that will be called when a user clicks the OK button

      Parameters

      Returns void

Optional open

open?: boolean

Whether the modal dialog is visible or not

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional style

style?: CSSProperties

Optional styles

styles?: Omit<ModalStyles, "wrapper">

Optional title

title?: ReactNode

The modal dialog's title

Optional transitionName

transitionName?: string

Optional visible

visible?: boolean

Deprecated

Please use open instead.

Optional width

width?: string | number

Width of the modal dialog

Optional wrapClassName

wrapClassName?: string

Optional wrapProps

wrapProps?: any

Optional zIndex

zIndex?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc