walkthrough-component
v0.2.7
Published
A walkthrough creator for introJS
Downloads
17
Readme
Using this component
Script tag
- Put a script tag similar to this
<script src='https://unpkg.com/walkthrough-component@<version>/dist/mycomponent.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
- usage :
<lk-walkthrough-creator contentId="myContentId"></lk-walkthrough-creator>
where contentId is the id of the element containing your app
const walkthroughCreatorElement = document.querySelector('lk-walkthrough-creator')
walkthroughCreatorElement.addEventListener('update', (ev) => {
// an array of configured steps will be emitted on event.detail
})
Node Modules
- Run
npm install walkthrough-component --save
- Put a script tag similar to this
<script src='node_modules/walkthrough-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
Contributing
and run:
npm install
npm start
To watch for file changes during develop, run:
npm run dev
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out Stencil docs here.