# step-tooltip

> step by step tooltip guilder for any website.lightweight, & minify✨✨✨.

Latest version **1.0.5** (published 2020-10-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install step-tooltip
pnpm add step-tooltip
yarn add step-tooltip
bun add step-tooltip
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2020-10-08 |
| First published | 2020-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10.0.0 |
| Dependencies | 0 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rabbitzzc |
| Maintainers | simida |
| Keywords | js-npm-template, npm-template, js |

## Links

- npm: https://www.npmjs.com/package/step-tooltip
- Repository: https://github.com/npm-template/js-npm-template
- Homepage: https://github.com/npm-template/js-npm-template#readme
- Issues: https://github.com/npm-template/js-npm-template/issues
- npm.io page: https://npm.io/package/step-tooltip

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.5 (latest) — 2020-10-08
- 1.0.4 — 2020-10-08
- 1.0.3 — 2020-09-22
- 1.0.2 — 2020-09-22

## README

<div align="center">
 <img align="center" width="180" src="https://github.com/Rabbitzzc/image-hosting-service/blob/master/step-tooltip-avator.png?raw=true" />
  <h2>Step Tooltip</h2>
  <blockquote>step by step tooltip guilder for any website.lightweight, & minify✨✨✨.</blockquote>
  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/step-tooltip">
  <img alt="npm" src="https://img.shields.io/npm/v/step-tooltip">
  <img alt="Travis (.org)" src="https://img.shields.io/travis/Rabbitzzc/step-tooltip">
  <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Rabbitzzc/step-tooltip">
  <img alt="node-current" src="https://img.shields.io/node/v/step-tooltip">
  <img alt="GitHub" src="https://img.shields.io/github/license/Rabbitzzc/step-tooltip">
  <img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/Rabbitzzc/step-tooltip">
  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Rabbitzzc/step-tooltip">

</div>


## ⭐️ Features

- Lightweight, minify.
- Generate arrows from pseudo-classes(before/after).


🤚🎨🤚🎨demo: https://step-tooltip-example.logiczc.vercel.app/


## 📦 Getting Started

### install
```sh
# npm 
npm install --save step-tooltip

# yarn
yarn add step-tooltip
```

### usage

```sh
import stepTooltip from 'step-tooltip'

stepTooltip()
```

### config

```js
{
  initialText: '哈喽，准备好了解 step-tooltip 了么？',
  steps: [],
  backdropColor: 'rgb(0 0 0 / 0.56)',
  options: {
    backLabel: '上一步',
    nextLabel: '下一步',
    skipLabel: '我知道了',
    doneLabel: '完成',
  }
}
```

| config        | func                              | default                                                      |
| ------------- | --------------------------------- | ------------------------------------------------------------ |
| initialText   | first show text                   | `哈喽，准备好了解 step-tooltip 了么？`                       |
| steps         | every step                        | `[]`                                                         |
| backdropColor | backdrop element box-shadow color | `'rgb(0 0 0 / 0.56)'`                                        |
| options       | other config                      | 1. backLabel: 上一步<br />2. nextLabel: 下一步<br />3. skipLabel: 我知道了<br />4. doneLabel: 完成 |



## 🔖 LICENSE

[MIT](./LICENSE)

## ✈️  Thanks
* [cssarrowplease](http://www.cssarrowplease.com/), css arrow.

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