# gitee-intro

> 一个用于创建功能引导界面的 JS 库

Latest version **1.10.1** (published 2020-04-15) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install gitee-intro
pnpm add gitee-intro
yarn add gitee-intro
bun add gitee-intro
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.10.1 |
| Published | 2020-04-15 |
| First published | 2019-11-28 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gitee |
| Maintainers | lc-soft |
| Keywords | intro |

## Links

- npm: https://www.npmjs.com/package/gitee-intro
- Repository: git@gitee.com:gitee-frontend/gitee-intro
- npm.io page: https://npm.io/package/gitee-intro

## Dependencies (1)

- [core-js](https://npm.io/package/core-js.md) ^3.4.2

## Recent versions

- 1.10.1 (latest) — 2020-04-15
- 1.10.1-beta.0 (beta) — 2020-04-08
- 1.10.1-beta — 2020-03-18
- 1.10.0 — 2020-03-16
- 1.10.0-beta.1 — 2020-03-09
- 1.10.0-beta.0 — 2020-02-22
- 1.10.0-beta — 2020-02-19
- 1.9.2 — 2020-01-03
- 1.9.1 — 2020-01-03
- 1.8.0 — 2020-01-02
- 1.8.0-beta — 2019-12-25
- 1.7.4 — 2019-12-20
- 1.7.3 — 2019-12-12
- 1.7.2 — 2019-12-12
- 1.7.1 — 2019-12-11
- … 12 more at https://npm.io/package/gitee-intro/versions

## README

# gitee-intro

[![npm](https://img.shields.io/npm/v/gitee-intro.svg)](https://gitee.com/gitee-frontend/gitee-intro/releases)
[![gitee-release-cli](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-gitee--release-blueviolet.svg)](https://gitee.com/gitee-frontend/gitee-reelase-cli/blob/master/LICENSE)

## 介绍

一个用于创建功能引导界面的 JS 库。

## 安装

```bash
npm install --save gitee-intro
```

## 使用

```js
import GiteeIntro from 'gitee-intro'

// 创建功能引导实例
const intro = new GiteeIntro({
    name: 'example',
    steps: [{
        type: 'Modal',
        title: '标题',
        content: {
            summary: '一段简单的介绍',
            features: [
                '特点1',
                '特点2',
            ],
            img: '图片地址'
        }
    }]
 })

// 开始引导
intro.start()
```

上述代码中用到了 Modal 控制器展示引导信息，你可以在 `src/controllers` 目录中找到其它控制器，配置参数可参考其源代码中的 `defaults` 对象内容。

## 发布

``` bash
# 创建 beta 预发行版
npm run release-beta

# 发布测试版
npm publish --tag=beta

# 创建正式发行版
npm run release

# 发布正式版
npm publish
```

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