# walkthrough-component

> A walkthrough creator for introJS

Latest version **0.2.7** (published 2018-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install walkthrough-component
pnpm add walkthrough-component
yarn add walkthrough-component
bun add walkthrough-component
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.7 |
| Published | 2018-06-21 |
| First published | 2018-06-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 (+10 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 289 |
| Author | Ionic Team |
| Maintainers | teleaziz |

## Links

- npm: https://www.npmjs.com/package/walkthrough-component
- Repository: https://github.com/ionic-team/stencil-component-starter
- Homepage: https://github.com/ionic-team/stencil
- Issues: https://github.com/ionic-team/stencil
- npm.io page: https://npm.io/package/walkthrough-component

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) 4.17.10
- [@ionic/core](https://npm.io/package/@ionic/core.md) 4.0.0-alpha.7
- [@medv/finder](https://npm.io/package/@medv/finder.md) 1.0.3
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.110
- [@types/intro.js](https://npm.io/package/@types/intro.js.md) 2.4.3

## Recent versions

- 0.2.7 (latest) — 2018-06-21
- 0.2.6 — 2018-06-19
- 0.2.5 — 2018-06-19
- 0.2.4 — 2018-06-19
- 0.2.3 — 2018-06-19
- 0.2.2 — 2018-06-19
- 0.2.1 — 2018-06-19
- 0.2.0 — 2018-06-19
- 0.1.2 — 2018-06-19
- 0.1.1 — 2018-06-19
- 0.1.0 — 2018-06-19
- 0.0.1 — 2018-06-19

## README

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)


## 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:

```bash
npm install
npm start
```

To watch for file changes during develop, run:

```bash
npm run dev
```

To build the component for production, run:

```bash
npm run build
```

To run the unit tests for the components, run:

```bash
npm test
```

Need help? Check out Stencil docs [here](https://stenciljs.com/docs/my-first-component).

---
_Source: https://npm.io/package/walkthrough-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._