Skip to main content
Version: 5.x

single-spa-cycle

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

Installation​

npm install --save @pcmnac/single-spa-cycle

Quickstart​

In your project's entry file, add the following:

import { run } from "@cycle/run";
import { makeDOMDriver } from "@cycle/dom";
import singleSpaCycle from "@pcmnac/single-spa-cycle";
import rootComponent from "./root.component.js";

const cycleLifecycles = singleSpaCycle({
  run,
  rootComponent,
  drivers: { DOM: makeDOMDriver(document.getElementById("main-content")) }, // or { DOM: makeDOMDriver('#main-content')}
});

export const bootstrap = cycleLifecycles.bootstrap;
export const mount = cycleLifecycles.mount;
export const unmount = cycleLifecycles.unmount;

Options​

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

  • run: (required) Cycle.js run function.
  • drivers: (required) Drivers (including DOM Driver) to be used by your Cycle.js root component.
  • rootComponent: (required) The top level Cycle.js component which will be rendered