@microsoft/sp-dialog/lib/IDialog.d.ts

SharePoint Framework support for displaying dialog boxes

/**
 * Options for showing a dialog
 *
 * @public
 */
export interface IDialogShowOptions {
    /**
     * A callback that is invoked immediately before the dialog receives focus.
     *
     * @remarks
     * Provide this callback if there is a case when you want to abort showing the dialog before it's approved
     * by the framework. For example, you can check if a long time has passed since the request was made or the
     * the component requesting the dialog is disposed and you don't want to show the dialog anymore. It is
     * important to keep this callback lightweight so the framework can resolve it quickly and the user interface
     * does not have to wait a long time for it.
     */
    confirmOpen?: () => boolean;
}
/**
 * Options for showing an alert dialog
 *
 * @public
 */
export interface IAlertOptions extends IDialogShowOptions {
}
/**
 * Options for showing a prompt dialog
 *
 * @public
 */
export interface IPromptOptions extends IDialogShowOptions {
    /**
     * The default value for the input text field of prompt dialog
     */
    defaultValue?: string;
}
/**
 * The interface for dialog configuration
 * @public
 */
export interface IDialogConfiguration {
    /**
     * Whether the dialog can be closed by clicking outside the dialog (on the overlay).
     */
    isBlocking?: boolean;
}
//# sourceMappingURL=IDialog.d.ts.map