@onboardist/ui

Reusable user onboarding UI components

Usage no npm install needed!

<script type="module">
  import onboardistUi from 'https://cdn.skypack.dev/@onboardist/ui';
</script>

README

Reusable user onboarding UI components

Build Status XO code style

Components

  • Coachmark
  • Hotspot
  • Tour
  • Tooltip

Development

Scheme

  1. Export each component individually from a single transpiled file. Tree-shaking on the using module's side will take care of excluding unused components.
  2. Use storybook to develop components
  3. Bundle with Rollup

Releases

npx np

Notes

  • Make components generate a unique ID on creation that is used in the id="" attribute, so they can be linked together.
    • Allow passing in Onboardist.UI instances as attach arguments. Use the id value (.get('id')) as the element selector to attach to.

Debugging

$ npm install --global inspect-process
$ inspect node_modules/ava/profile.js test/main.js