IToolbarWidgetRegistry | @jupyterlab (original) (raw)

interface IToolbarWidgetRegistry {
defaultFactory: (
widgetFactory: string,
widget: Widget,
toolbarItem: IWidget,
) => Widget;
factoryAdded: ISignal<IToolbarWidgetRegistry, string>;
addFactory<T extends Widget = Widget>(
widgetFactory: string,
toolbarItemName: string,
factory: (main: T) => Widget,
): undefined | (main: T) => Widget;
createWidget(
widgetFactory: string,
widget: Widget,
toolbarItem: IWidget,
): Widget;
registerFactory<T extends Widget = Widget>(
widgetFactory: string,
toolbarItemName: string,
factory: (main: T) => Widget,
): undefined | (main: T) => Widget;
}

Implemented by

• ToolbarWidgetRegistry

Index

Properties

defaultFactory

defaultFactory: (
widgetFactory: string,
widget: Widget,
toolbarItem: IWidget,
) => Widget

ReadonlyfactoryAdded

Methods

addFactory

• addFactory<T extends Widget = Widget>(
  widgetFactory: string,
  toolbarItemName: string,
  factory: (main: T) => Widget,
  ): undefined | (main: T) => Widget

• Type Parameters

  • T extends Widget = Widget

Parameters

• widgetFactory: string
• toolbarItemName: string
• factory: (main: T) => Widget

Returns undefined | (main: T) => Widget

The previously defined factory

createWidget

• createWidget(
  widgetFactory: string,
  widget: Widget,
  toolbarItem: IWidget,
  ): Widget

• Parameters

  • widgetFactory: string
  • widget: Widget
  • toolbarItem: IWidget

Returns Widget

The widget to be inserted in the toolbar.

registerFactory

• registerFactory<T extends Widget = Widget>(
  widgetFactory: string,
  toolbarItemName: string,
  factory: (main: T) => Widget,
  ): undefined | (main: T) => Widget

• Type Parameters

  • T extends Widget = Widget

Parameters

• widgetFactory: string
• toolbarItemName: string
• factory: (main: T) => Widget

Returns undefined | (main: T) => Widget

The previously defined factory