Options
All
  • Public
  • Public/Protected
  • All
Menu

Module apputils

Index

Type aliases

ClipboardData

ClipboardData: string | MimeData

Variables

Const ICommandPalette

ICommandPalette: Token<ICommandPalette>

The command palette token.

Const ISanitizer

ISanitizer: Token<ISanitizer>

The sanitizer token.

Let ISessionContextDialogs

ISessionContextDialogs: Token

The session context dialogs token.

Const ISplashScreen

ISplashScreen: Token<ISplashScreen>

The main menu token.

Const IThemeManager

IThemeManager: Token<IThemeManager>

The theme manager token.

Const IWindowResolver

IWindowResolver: Token<IWindowResolver>

The default window resolver token.

Const defaultSanitizer

defaultSanitizer: ISanitizer

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

Const sessionContextDialogs

sessionContextDialogs: IDialogs

The default implementation of the client sesison dialog provider.

Functions

CommandToolbarButtonComponent

  • CommandToolbarButtonComponent(props: IProps): JSX.Element
  • React component for a toolbar button that wraps a command.

    This wraps the ToolbarButtonComponent and watches the command registry for changes to the command.

    Parameters

    Returns JSX.Element

ToolbarButtonComponent

  • ToolbarButtonComponent(props: IProps): JSX.Element
  • React component for a toolbar button.

    Parameters

    • props: IProps

      The props for ToolbarButtonComponent.

    Returns JSX.Element

addCommandToolbarButtonClass

  • addCommandToolbarButtonClass(w: Widget): Widget
  • Parameters

    • w: Widget

    Returns Widget

addToolbarButtonClass

  • addToolbarButtonClass(w: Widget): Widget
  • Adds the toolbar button class to the toolbar widget.

    Parameters

    • w: Widget

      Toolbar button widget.

    Returns Widget

showDialog

  • Create and show a dialog.

    Type parameters

    • T

    Parameters

    • Optional 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>
  • 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).

    • Optional buttons: ReadonlyArray<IButton>

    Returns Promise<void>

Generated using TypeDoc