Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.73 KB

ecosystem-riot.md

File metadata and controls

45 lines (31 loc) · 1.73 KB
Raw
id title sidebar_label
ecosystem-riot
single-spa-riot
Riot

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

NPM

Build Status

minified

Installation

npm install --save single-spa-riot

Usage

import * as Riot from 'riot';
import singleSpaRiot from 'single-spa-riot';
import App from './App.riot'

const riotLifecycles = singleSpaRiot({
  rootComponent: Riot.component(App),
  domElementGetter: () => document.getElementById('#app')
});

export const bootstrap = riotLifecycles.bootstrap;

export const mount = riotLifecycles.mount;

export const unmount = riotLifecycles.unmount;

Options

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

  • domElementGetter: (required) the callback to get root component mount element.
  • rootComponent: (optional and replaces appOptions.loadRootComponent) the root riot component.
  • loadRootComponent: (optional and replaces appOptions.rootComponent) A promise that resolves with your root component. This is useful for lazy loading.