Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WidgetFactory

A WidgetFactory is used to create new widgets. Factory-specific information (options) can be passed as serializable JSON data. The common WidgetManager collects WidgetFactory contributions and delegates to the corresponding factory when a widget should be created or restored. To identify widgets the WidgetManager uses a description composed of the factory id and the options. The WidgetFactory does support both, synchronous and asynchronous widget creation.

Example usage

 
export class MyWidget extends BaseWidget {
}

@injectable()
export class MyWidgetFactory implements WidgetFactory {
    id = 'myWidgetFactory';

    createWidget(): MaybePromise<Widget> {
        return new MyWidget();
   }
}

Hierarchy

  • WidgetFactory

Index

Properties

Methods

Properties

Readonly id

id: string

The factory id.

Methods

createWidget