Version: 5.x

single-spa-dojo

Build Status

single-spa-dojo is a helper library that helps implement single-spa registered application lifecycle functions (bootstrap, mount and unmount) for use with Dojo. Check out the single-spa-dojo github.

  1. npm install --save single-spa-dojo
  3. # or
  4. yarn add single-spa-dojo

Your bundler’s “entry file” should look like this, which allows your application to be downloaded as an in-browser ES module.

  1. import { renderer } from '@dojo/framework/core/vdom';
  2. import { v, w } from '@dojo/framework/widget-core/d';
  3. import singleSpaDojo from 'single-spa-dojo';
  4. import App from './app';
  6. const dojoLifecycles = singleSpaDojo({
  7.   // required
  8.   renderer,
  10.   // required
  11.   v,
  13.   // required
  14.   w,
  16.   // required
  17.   appComponent: App,
  19.   // optional - see https://dojo.io/learn/creating-widgets/rendering-widgets#mountoptions-properties
  20.   mountOptions: {
  21.     // optional
  22.     registry: myRegistry,
  24.     // optional - one will be provided by single-spa automatically
  25.     domNode: document.getElementById('myContainer'),
  27.     // optional
  28.     sync: true
  29.   }
  30. });
  32. export const bootstrap = dojoLifecycles.bootstrap;
  33. export const mount = dojoLifecycles.mount;
  34. export const unmount = dojoLifecycles.unmount;

All options are passed to single-spa-dojo via the opts parameter when calling singleSpaDojo(opts). The following options are available:

  • renderer (required): The renderer function imported from Dojo. See https://dojo.io/learn/creating-widgets/rendering-widgets#rendering-to-the-dom.
  • v (required): The function used to render dom elements in Dojo. Often JSX hides this function from you, but it can be found at import { v } from '@dojo/framework/widget-core/d'.
  • w (required): The function used to render dom elements in Dojo. Often JSX hides this function from you, but it can be found at import { w } from '@dojo/framework/widget-core/d'.
  • appComponent (required): The class or function for your root Dojo component.
  • mountOptions (optional): An object of Dojo MountOptions. Note that a domNode will be provided by single-spa-dojo, if one is not provided.

Dojo - 图2Edit this page