import { ITranslator } from '@jupyterlab/translation'; import { Message } from '@lumino/messaging'; import { Widget } from '@lumino/widgets'; import * as React from 'react'; import { WidgetTracker } from './widgettracker'; /** * Create and show a dialog. * * @param options - The dialog setup options. * * @returns A promise that resolves with whether the dialog was accepted. */ export declare function showDialog(options?: Partial>): Promise>; /** * Show an error message dialog. * * @param title - The title of the dialog box. * * @param error - the error to show in the dialog body (either a string * or an object with a string `message` property). */ export declare function showErrorMessage(title: string, error: string | Dialog.IError, buttons?: ReadonlyArray): Promise; /** * A modal dialog widget. */ export declare class Dialog extends Widget { /** * Create a dialog panel instance. * * @param options - The dialog setup options. */ constructor(options?: Partial>); /** * A promise that resolves when the Dialog first rendering is done. */ get ready(): Promise; /** * Dispose of the resources used by the dialog. */ dispose(): void; /** * Launch the dialog as a modal window. * * @returns a promise that resolves with the result of the dialog. */ launch(): Promise>; /** * Resolve the current dialog. * * @param index - An optional index to the button to resolve. * * #### Notes * Will default to the defaultIndex. * Will resolve the current `show()` with the button value. * Will be a no-op if the dialog is not shown. */ resolve(index?: number): void; /** * Reject the current dialog with a default reject value. * * #### Notes * Will be a no-op if the dialog is not shown. */ reject(): void; /** * Handle the DOM events for the directory listing. * * @param event - The DOM event sent to the widget. * * #### Notes * This method implements the DOM `EventListener` interface and is * called in response to events on the panel's DOM node. It should * not be called directly by user code. */ handleEvent(event: Event): void; /** * A message handler invoked on an `'after-attach'` message. */ protected onAfterAttach(msg: Message): void; /** * A message handler invoked on an `'after-detach'` message. */ protected onAfterDetach(msg: Message): void; /** * A message handler invoked on a `'close-request'` message. */ protected onCloseRequest(msg: Message): void; /** * Handle the `'input'` event for dialog's children. * * @param event - The DOM event sent to the widget */ protected _evtInput(_event: InputEvent): void; /** * Handle the `'click'` event for a dialog button. * * @param event - The DOM event sent to the widget */ protected _evtClick(event: MouseEvent): void; /** * Handle the `'keydown'` event for the widget. * * @param event - The DOM event sent to the widget */ protected _evtKeydown(event: KeyboardEvent): void; /** * Handle the `'focus'` event for the widget. * * @param event - The DOM event sent to the widget */ protected _evtFocus(event: FocusEvent): void; /** * Handle the `'mousedown'` event for the widget. * * @param event - The DOM event sent to the widget */ protected _evtMouseDown(event: MouseEvent): void; /** * Resolve a button item. */ private _resolve; private _hasValidationErrors; private _ready; private _buttonNodes; private _buttons; private _checkboxNode; private _original; private _first; private _primary; private _promise; private _defaultButton; private _host; private _hasClose; private _body; private _lastMouseDownInDialog; private _focusNodeSelector; private _bodyWidget; } /** * The namespace for Dialog class statics. */ export declare namespace Dialog { /** * Translator object. */ let translator: ITranslator; /** * The body input types. */ type Body = IBodyWidget | React.ReactElement | string; /** * The header input types. */ type Header = React.ReactElement | string; /** * A widget used as a dialog body. */ interface IBodyWidget extends Widget { /** * Get the serialized value of the widget. */ getValue?(): T; } /** * The options used to make a button item. */ interface IButton { /** * The aria label for the button. */ ariaLabel: string; /** * The label for the button. */ label: string; /** * The icon class for the button. */ iconClass: string; /** * The icon label for the button. */ iconLabel: string; /** * The caption for the button. */ caption: string; /** * The extra class name for the button. */ className: string; /** * The dialog action to perform when the button is clicked. */ accept: boolean; /** * The additional dialog actions to perform when the button is clicked. */ actions: Array; /** * The button display type. */ displayType: 'default' | 'warn'; } /** * The options used to make a checkbox item. */ interface ICheckbox { /** * The label for the checkbox. */ label: string; /** * The caption for the checkbox. */ caption: string; /** * The initial checkbox state. */ checked: boolean; /** * The extra class name for the checkbox. */ className: string; } /** * Error object interface */ interface IError { /** * Error message */ message: string | React.ReactElement; } /** * The options used to create a dialog. */ interface IOptions { /** * The top level text for the dialog. Defaults to an empty string. */ title: Header; /** * The main body element for the dialog or a message to display. * Defaults to an empty string. * * #### Notes * If a widget is given as the body, it will be disposed after the * dialog is resolved. If the widget has a `getValue()` method, * the method will be called prior to disposal and the value * will be provided as part of the dialog result. * A string argument will be used as raw `textContent`. * All `input` and `select` nodes will be wrapped and styled. */ body: Body; /** * The host element for the dialog. Defaults to `document.body`. */ host: HTMLElement; /** * The buttons to display. Defaults to cancel and accept buttons. */ buttons: ReadonlyArray; /** * The checkbox to display in the footer. Defaults no checkbox. */ checkbox: Partial | null; /** * The index of the default button. Defaults to the last button. */ defaultButton: number; /** * A selector for the primary element that should take focus in the dialog. * Defaults to an empty string, causing the [[defaultButton]] to take * focus. */ focusNodeSelector: string; /** * When "false", disallows user from dismissing the dialog by clicking outside it * or pressing escape. Defaults to "true", which renders a close button. */ hasClose: boolean; /** * An optional renderer for dialog items. Defaults to a shared * default renderer. */ renderer: IRenderer; } /** * A dialog renderer. */ interface IRenderer { /** * Create the header of the dialog. * * @param title - The title of the dialog. * * @returns A widget for the dialog header. */ createHeader(title: Header, reject: () => void, options: Partial>): Widget; /** * Create the body of the dialog. * * @param body - The input value for the body. * * @returns A widget for the body. */ createBody(body: Body): Widget; /** * Create the footer of the dialog. * * @param buttons - The button nodes to add to the footer. * @param checkbox - The checkbox node to add to the footer. * * @returns A widget for the footer. */ createFooter(buttons: ReadonlyArray, checkbox: HTMLElement | null): Widget; /** * Create a button node for the dialog. * * @param button - The button data. * * @returns A node for the button. */ createButtonNode(button: IButton): HTMLButtonElement; /** * Create a checkbox node for the dialog. * * @param checkbox - The checkbox data. * * @returns A node for the checkbox. */ createCheckboxNode(checkbox: ICheckbox): HTMLElement; } /** * The result of a dialog. */ interface IResult { /** * The button that was pressed. */ button: IButton; /** * State of the dialog checkbox. * * #### Notes * It will be null if no checkbox is defined for the dialog. */ isChecked: boolean | null; /** * The value retrieved from `.getValue()` if given on the widget. */ value: T | null; } /** * Create a button item. */ function createButton(value: Partial): Readonly; /** * Create a reject button. */ function cancelButton(options?: Partial): Readonly; /** * Create an accept button. */ function okButton(options?: Partial): Readonly; /** * Create a warn button. */ function warnButton(options?: Partial): Readonly; /** * Disposes all dialog instances. * * #### Notes * This function should only be used in tests or cases where application state * may be discarded. */ function flush(): void; /** * The default implementation of a dialog renderer. */ class Renderer { /** * Create the header of the dialog. * * @param title - The title of the dialog. * * @returns A widget for the dialog header. */ createHeader(title: Header, reject?: () => void, options?: Partial>): Widget; /** * Create the body of the dialog. * * @param value - The input value for the body. * * @returns A widget for the body. */ createBody(value: Body): Widget; /** * Create the footer of the dialog. * * @param buttons - The buttons nodes to add to the footer. * @param checkbox - The checkbox node to add to the footer. * * @returns A widget for the footer. */ createFooter(buttons: ReadonlyArray, checkbox: HTMLElement | null): Widget; /** * Create a button node for the dialog. * * @param button - The button data. * * @returns A node for the button. */ createButtonNode(button: IButton): HTMLButtonElement; /** * Create a checkbox node for the dialog. * * @param checkbox - The checkbox data. * * @returns A node for the checkbox. */ createCheckboxNode(checkbox: ICheckbox): HTMLElement; /** * Create the class name for the button. * * @param data - The data to use for the class name. * * @returns The full class name for the button. */ createItemClass(data: IButton): string; /** * Render an icon element for a dialog item. * * @param data - The data to use for rendering the icon. * * @returns An HTML element representing the icon. */ renderIcon(data: IButton): HTMLElement; /** * Create the class name for the button icon. * * @param data - The data to use for the class name. * * @returns The full class name for the item icon. */ createIconClass(data: IButton): string; /** * Render the label element for a button. * * @param data - The data to use for rendering the label. * * @returns An HTML element representing the item label. */ renderLabel(data: IButton): HTMLElement; } /** * The default renderer instance. */ const defaultRenderer: Renderer; /** * The dialog widget tracker. */ const tracker: WidgetTracker>; }