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

SharePoint Framework support for displaying dialog boxes

import type { IAlertOptions, IPromptOptions } from './IDialog';
/**
 * A static class for showing stock dialogs such as an alert or prompt.
 *
 * @public
 */
export default class Dialog {
    /**
     * Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application
     * to show the alert dialog.
     *
     * @remarks
     * There might be a delay until the dialog is approved and shown by the application, for
     * example, if there is another dialog currently being shown. The returned promise resolves when the dialog is
     * successfully shown and closed. The promise rejects if the application rejects the request for any reason.
     *
     * @param message - The message to alert
     */
    static alert(message: string, options?: IAlertOptions): Promise<void>;
    /**
     * Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to
     * application to show the dialog.
     *
     * @remarks
     * There might be a delay until the dialog is approved and shown by the application,
     * for example, if there is another dialog currently being shown. The returned promise resolves when the dialog is
     * successfully shown and closed. The promise rejects if the application rejects the request for any reason.
     *
     * @returns The input string or undefined if the dialog was canceled
     *
     * @param message - The message for prompt dialog
     */
    static prompt(message: string, options?: IPromptOptions): Promise<string | undefined>;
}
//# sourceMappingURL=Dialog.d.ts.map