UNPKG

1.74 kBMarkdownView Raw
1# bee-alert
2[![npm version](https://img.shields.io/npm/v/bee-alert.svg)](https://www.npmjs.com/package/bee-alert)
3[![Build Status](https://img.shields.io/travis/tinper-bee/bee-alert/master.svg)](https://travis-ci.org/tinper-bee/bee-alert)
4[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-alert/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-alert?branch=master)
5[![devDependency Status](https://img.shields.io/david/dev/tinper-bee/bee-alert.svg)](https://david-dm.org/tinper-bee/bee-alert#info=devDependencies)
6
7
8为用户操作定向的做提示。根据信息类型不同提供相应的以背景颜色区分的alert。若需背景颜色加深需加`dark`类。
9
10## 使用
11
12使用单独的bee-alert包
13#### 组件引入
14先进行下载bee-alert包
15
16```
17npm install --save bee-alert
18```
19组件调用
20```js
21import Alert from 'bee-alert';
22
23React.render(<div>
24 <Alert />
25 <Alert colors="info" className="dark" closeLabel="close" />
26</div>, document.getElementById('target'));
27
28```
29#### 样式引入
30- 可以使用link引入dist目录下bee-alert.css
31```
32<link rel="stylesheet" href="./node_modules/build/bee-alert.css">
33```
34- 可以在js中import样式
35```js
36import "./node_modules/src/Alert.scss"
37//或是
38import "./node_modules/build/bee-alert.css"
39```
40
41
42
43
44## API
45
46|参数|说明|类型|默认值|
47|:--|:---:|:--:|---:|
48|className|类名|string||
49|colors|oneOf:`info` `news` `success` `danger` `warning`|string|`warning`|
50|controlLabel|关闭按钮文字|string||
51|onDismiss|关闭alert触发的方法|func||
52
53
54#### 开发调试
55
56```sh
57$ git clone https://github.com/tinper-bee/bee-alert
58$ cd bee-alert
59$ npm install
60$ npm run dev
61```