[Improvement] Reorganize document (#1066)

2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
@@ -0,0 +1,58 @@
+## NoticeBar
+
+### Install
+``` javascript
+import { NoticeBar } from 'vant';
+
+Vue.use(NoticeBar);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<van-notice-bar
+  text="Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily."
+  left-icon="https://img.yzcdn.cn/1.png"
+/>
+```
+
+#### Disable scroll
+
+```html
+<van-notice-bar :scrollable="false">
+  Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily.
+</van-notice-bar>
+```
+
+#### Mode
+
+```html
+<van-notice-bar mode="closeable">
+  Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily.
+</van-notice-bar>
+
+<van-notice-bar mode="link">
+  Only those who have the patience to do simple things perfectly ever acquire the skill to do difficult things easily.
+</van-notice-bar>
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| mode | Mode, can be set to `closeable` `link` | `String` | `''` |
+| delay | Animation delay (s) | `Number` | `1` |
+| speed | Scroll speed (px/s) | `Number` | `50` |
+| scrollable | Whether to scroll content | `Boolean` | `true` |
+| left-icon | Image url of left icon | `String` | - |
+| color | Text color | `String` | `#f60` |
+| background | Background color | `String` | `#fff7cc` |
+
+
+### Event
+
+| Event | Description | Arguments |
+|-----------|-----------|-----------|
+| click | Triggered when click notice bar | - |