@jupyterlab/apputils

Index

Modules

Classes

Interfaces

Variables

defaultSanitizer

Functions

Variables

Const defaultSanitizer

defaultSanitizer: ISanitizer = new Sanitizer()

The default instance of an ISanitizer meant for use by user code.

Functions

addCommandToolbarButtonClass

addCommandToolbarButtonClass(w: Widget): Widget

- Defined in toolbar.tsx:550
Parameters
- w: Widget
Returns Widget

addToolbarButtonClass

addToolbarButtonClass(w: Widget): Widget

- Defined in toolbar.tsx:489
Adds the toolbar button class to the toolbar widget.

Parameters
- w: Widget
  
  Toolbar button widget.
Returns Widget

showDialog

showDialog<T>(options?: Partial<IOptions<T>>): Promise<IResult<T>>

- Defined in dialog.ts:27
Create and show a dialog.

Type parameters
- T
Parameters
- Default value options: Partial<IOptions<T>> = {}
  
  The dialog setup options.
Returns Promise<IResult<T>>

A promise that resolves with whether the dialog was accepted.

showErrorMessage

showErrorMessage(title: string, error: any, buttons?: ReadonlyArray<IButton>): Promise<void>

- Defined in dialog.ts:42
Show an error message dialog.

Parameters
- title: string
  
  The title of the dialog box.
- error: any
  
  the error to show in the dialog body (either a string or an object with a string message property).
- Default value buttons: ReadonlyArray<IButton> = [Dialog.okButton({ label: 'Dismiss' })]
Returns Promise<void>

Generated using TypeDoc