UNPKG

bee-message/README.md

Version:

2.91 kBMarkdownView Raw

1# bee-message
2
3[![npm version](https://img.shields.io/npm/v/bee-message.svg)](https://www.npmjs.com/package/bee-message)
4[![Build Status](https://img.shields.io/travis/tinper-bee/bee-message/master.svg)](https://travis-ci.org/tinper-bee/bee-message)
5[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-message/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-message?branch=master)
6
7
8## Browser Support
9
10|![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png)|
11| --- | --- | --- | --- | --- |
12| IE 9+ ✔ | Chrome 31.0+ ✔ | Firefox 31.0+ ✔ | Opera 30.0+ ✔ | Safari 7.0+ ✔ |
13
14
15react bee-message component for tinper-bee
16
17全局展示操作反馈信息。
18
19应用场景：
20- 可提供成功、警告和错误等反馈信息。
21- 当需要提醒但是不打断操作时，是一种不打断用户操作的轻量级提示方式。
22
23## 使用方法
24
25```js
26const info = function () {
27  Message.create({content: 'This is a Info message', color: 'info'});
28};
29
30class Demo extends Component {
31    render () {
32        return (
33            <Button
34                colors="info"
35                onClick={info}>
36                info
37            </Button>
38        )
39    }
40}
41
42```
43
44#### 样式引入
45
46- 可以使用link引入build目录下Message.css
47```
48<link rel="stylesheet" href="./node_modules/bee-message/build/Message.css">
49```
50- 可以在js中import样式
51```js
52import "./node_modules/bee-message/src/Message.scss"
53//或是
54import "./node_modules/bee-message/build/Message.css"
55```
56
57
58## API
59
60#### 函数api
61
62```
63//设置默认设置
64Message.config({
65    top: 20,  //顶上显示时距顶部的位置
66    bottom: 20, //左下右下显示时距底部的位置
67    defaultBottom: 20, //底部显示时距底部的位置
68    duration: 20, //显示持续时间
69    width: 500 //左下左上右下右上显示时的宽度
70    });
71
72//销毁所有消息
73Message.destroy();
74
75//创建消息
76Messsage.create({});
77
78```
79
80#### message函数参数
81
82|参数|说明|类型|默认值|
83|:---|:-----|:----|:------|
84|content|内容|string/number|-|
85|duration|显示时间|number|3|
86|color|颜色|dark/light/success/danger/warning/info/successlight/dangerlight/warninglight/infolight|'dark'|
87|onClose|关闭时的钩子函数|function|-|
88|position|位置|top/bottom/topRight/topLeft/bottomRight/bottomLeft|top|
89|style|样式|object|{}|
90```
91
92#### 开发调试
93
94```sh
95$ npm install -g bee-tools
96$ git clone https://github.com/tinper-bee/bee-message
97$ cd bee-message
98$ npm install
99$ npm run dev
100```

1	`# bee-message`
2
3	`[![npm version](https://img.shields.io/npm/v/bee-message.svg)](https://www.npmjs.com/package/bee-message)`
4	`[![Build Status](https://img.shields.io/travis/tinper-bee/bee-message/master.svg)](https://travis-ci.org/tinper-bee/bee-message)`
5	`[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-message/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-message?branch=master)`
6
7
8	`## Browser Support`
9
10	`\|![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) \| ![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) \| ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) \| ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png) \| ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png)\|`
11	`\| --- \| --- \| --- \| --- \| --- \|`
12	`\| IE 9+ ✔ \| Chrome 31.0+ ✔ \| Firefox 31.0+ ✔ \| Opera 30.0+ ✔ \| Safari 7.0+ ✔ \|`
13
14
15	`react bee-message component for tinper-bee`
16
17	`全局展示操作反馈信息。`
18
19	`应用场景：`
20	`- 可提供成功、警告和错误等反馈信息。`
21	`- 当需要提醒但是不打断操作时，是一种不打断用户操作的轻量级提示方式。`
22
23	`## 使用方法`
24
25	```js
26	`const info = function () {`
27	`Message.create({content: 'This is a Info message', color: 'info'});`
28	`};`
29
30	`class Demo extends Component {`
31	`render () {`
32	`return (`
33	`<Button`
34	`colors="info"`
35	`onClick={info}>`
36	`info`
37	`</Button>`
38	`)`
39	`}`
40	`}`
41
42	```
43
44	`#### 样式引入`
45
46	`- 可以使用link引入build目录下Message.css`
47	```
48	`<link rel="stylesheet" href="./node_modules/bee-message/build/Message.css">`
49	```
50	`- 可以在js中import样式`
51	```js
52	`import "./node_modules/bee-message/src/Message.scss"`
53	`//或是`
54	`import "./node_modules/bee-message/build/Message.css"`
55	```
56
57
58	`## API`
59
60	`#### 函数api`
61
62	```
63	`//设置默认设置`
64	`Message.config({`
65	`top: 20, //顶上显示时距顶部的位置`
66	`bottom: 20, //左下右下显示时距底部的位置`
67	`defaultBottom: 20, //底部显示时距底部的位置`
68	`duration: 20, //显示持续时间`
69	`width: 500 //左下左上右下右上显示时的宽度`
70	`});`
71
72	`//销毁所有消息`
73	`Message.destroy();`
74
75	`//创建消息`
76	`Messsage.create({});`
77
78	```
79
80	`#### message函数参数`
81
82	`\|参数\|说明\|类型\|默认值\|`
83	`\|:---\|:-----\|:----\|:------\|`
84	`\|content\|内容\|string/number\|-\|`
85	`\|duration\|显示时间\|number\|3\|`
86	`\|color\|颜色\|dark/light/success/danger/warning/info/successlight/dangerlight/warninglight/infolight\|'dark'\|`
87	`\|onClose\|关闭时的钩子函数\|function\|-\|`
88	`\|position\|位置\|top/bottom/topRight/topLeft/bottomRight/bottomLeft\|top\|`
89	`\|style\|样式\|object\|{}\|`
90	```
91
92	`#### 开发调试`
93
94	```sh
95	`$ npm install -g bee-tools`
96	`$ git clone https://github.com/tinper-bee/bee-message`
97	`$ cd bee-message`
98	`$ npm install`
99	`$ npm run dev`
100	```