sherpa-onboarding
v0.0.2
Published
Sherpa re-usable widget
Downloads
1
Readme
Sherpa Onboarding
This is a re-usable widget created with StencilJS.
Getting Started
To start building a new web component using Stencil run
npm install
npm run start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Using this component
There are three strategies we recommend for using web components built with Stencil.
The first step for all three of these strategies is to publish to NPM.
Script tag
- Put a script tag similar to this
<script src='https://unpkg.com/[email protected]/dist/mycomponent.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm install my-component --save
- Put a script tag similar to this
<script src='node_modules/my-component/dist/mycomponent.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
In a stencil-starter app
- Run
npm install my-component --save
- Add an import to the npm packages
import my-component;
- Then you can use the element anywhere in your template, JSX, html etc