office-ui-fabric-react/lib/components/Dialog/Dialog.Props.d.ts

Reusable React components for building experiences for Office 365.

import * as React from 'react';
import { Dialog } from './Dialog';
import { IWithResponsiveModeState } from '../../utilities/decorators/withResponsiveMode';
import { IAccessiblePopupProps } from '../../common/IAccessiblePopupProps';
export interface IDialogProps extends React.Props<Dialog>, IWithResponsiveModeState, IAccessiblePopupProps {
    /**
    * Whether the dialog is displayed.
    * @default false
    */
    isOpen?: boolean;
    /**
    * The type of Dialog to display.
    * @default DialogType.normal
    */
    type?: DialogType;
    /**
    * Whether the overlay is dark themed.
    * @default true
    */
    isDarkOverlay?: boolean;
    /**
    * A callback function for when the Dialog is dismissed from the close button or light dismiss.
    */
    onDismiss?: (ev?: React.MouseEvent<HTMLButtonElement>) => any;
    /**
    * The title text to display at the top of the dialog.
    */
    title?: string;
    /**
    * The subtext to display in the dialog.
    */
    subText?: string;
    /**
    * Whether the dialog can be light dismissed by clicking outside the dialog (on the overlay).
    * @default false
    */
    isBlocking?: boolean;
    /**
     * Optional class name to be added to the root class
     */
    className?: string;
    /**
    * Optional override for container class
    */
    containerClassName?: string;
    /**
    * Optional override content class
    */
    contentClassName?: string;
    /**
     * A callback function for when the Dialog content is mounted on the overlay layer
     */
    onLayerMounted?: () => void;
}
export declare enum DialogType {
    /** Standard dialog */
    normal = 0,
    /** Dialog with large header banner */
    largeHeader = 1,
    /** Dialog with an 'x' close button in the upper-right corner */
    close = 2,
}