Interface IToolbarWidgetRegistry

Toolbar widget registry interface

Hierarchy

IToolbarWidgetRegistry

Index

Properties

defaultFactory

Methods

Properties

defaultFactory

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

Type declaration

- (widgetFactory: string, widget: Widget, toolbarItem: IWidget): Widget
- Default toolbar item factory
  
  Parameters
  - widgetFactory: string
  - widget: Widget
  - toolbarItem: IWidget
  Returns Widget

Methods

createWidget

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

- Defined in packages/apputils/lib/tokens.d.ts:208
Create a toolbar item widget

Parameters
- widgetFactory: string
  
  The widget factory name that creates the toolbar
- widget: Widget
  
  The newly widget containing the toolbar
- toolbarItem: IWidget
  
  The toolbar item definition
Returns Widget

The widget to be inserted in the toolbar.

registerFactory

registerFactory<T>(widgetFactory: string, toolbarItemName: string, factory: (main: T) => Widget): (main: T) => Widget

- Defined in packages/apputils/lib/tokens.d.ts:217
Register a new toolbar item factory

Type parameters
- T: Widget<T> = Widget
Parameters
- widgetFactory: string
  
  The widget factory name that creates the toolbar
- toolbarItemName: string
  
  The unique toolbar item
- factory: (main: T) => Widget
  
  The factory function that receives the widget containing the toolbar and returns the toolbar widget.
  - - (main: T): Widget
    - Parameters
      - main: T
      Returns Widget
Returns (main: T) => Widget

The previously defined factory
- - (main: T): Widget
  - Parameters
    - main: T
    Returns Widget

Generated using TypeDoc