Options
All
  • Public
  • Public/Protected
  • All
Menu

Module vdom-extension

Index

Variables

Variables

Const MIME_TYPE

MIME_TYPE: "application/vdom.v1+json" = "application/vdom.v1+json"

The MIME type for VDOM.

Const default

default: JupyterFrontEndPlugin<IVDOMTracker> = {id: '@jupyterlab/vdom-extension:factory',requires: [IRenderMimeRegistry],optional: [INotebookTracker, ILayoutRestorer],provides: IVDOMTracker,autoStart: true,activate: (app: JupyterFrontEnd,rendermime: IRenderMimeRegistry,notebooks: INotebookTracker | null,restorer: ILayoutRestorer | null) => {const tracker = new WidgetTracker<MimeDocument>({namespace: 'vdom-widget'});// Add a renderer factory to application rendermime registry.rendermime.addFactory({safe: false,mimeTypes: [MIME_TYPE],createRenderer: options => new RenderedVDOM(options)},0);if (notebooks) {notebooks.widgetAdded.connect((sender, panel) => {// Get the notebook's context and rendermime;const {context,content: { rendermime }} = panel;// Add the renderer factory to the notebook's rendermime registry;rendermime.addFactory({safe: false,mimeTypes: [MIME_TYPE],createRenderer: options => new RenderedVDOM(options, context)},0);});}app.docRegistry.addFileType({name: 'vdom',mimeTypes: [MIME_TYPE],extensions: ['.vdom', '.vdom.json'],icon: reactIcon});const factory = new MimeDocumentFactory({renderTimeout: 1000,dataType: 'json',rendermime,name: FACTORY_NAME,primaryFileType: app.docRegistry.getFileType('vdom')!,fileTypes: ['vdom', 'json'],defaultFor: ['vdom']});factory.widgetCreated.connect((sender, widget) => {widget.context.pathChanged.connect(() => {void tracker.save(widget);});void tracker.add(widget);});// Add widget factory to document registry.app.docRegistry.addWidgetFactory(factory);if (restorer) {// Handle state restoration.void restorer.restore(tracker, {command: 'docmanager:open',args: widget => ({path: widget.context.path,factory: FACTORY_NAME}),name: widget => widget.context.path});}return tracker;}}

Generated using TypeDoc