[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 | - |
@@ -0,0 +1,61 @@
+## NoticeBar 通告栏
+
+### 使用指南
+``` javascript
+import { NoticeBar } from 'vant';
+
+Vue.use(NoticeBar);
+```
+
+### 代码演示
+
+#### 基础用法
+
+```html
+<van-notice-bar
+  text="足协杯战线连续第2年上演广州德比战，上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。"
+  left-icon="https://img.yzcdn.cn/1.png"
+/>
+```
+
+#### 禁用滚动
+文字内容多于一行时，可通过`scrollable`参数控制是否开启滚动
+
+```html
+<van-notice-bar :scrollable="false">
+  足协杯战线连续第2年上演广州德比战，上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
+</van-notice-bar>
+```
+
+#### 通告栏模式
+默认模式为空，支持`closeable`和`link`。
+
+```html
+<!-- closeable 模式，在右侧显示关闭按钮 -->
+<van-notice-bar mode="closeable">
+  足协杯战线连续第2年上演广州德比战，上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
+</van-notice-bar>
+
+<!-- link 模式，在右侧显示链接箭头 -->
+<van-notice-bar mode="link">
+  足协杯战线连续第2年上演广州德比战，上赛季半决赛上恒大以两回合5-3的总比分淘汰富力。
+</van-notice-bar>
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| mode | 通告栏模式，可选值为 `closeable` `link` | `String` | `''` |
+| delay | 动画延迟时间 (s) | `Number` | `1` |
+| speed | 滚动速率 (px/s) | `Number` | `50` |
+| scrollable | 是否在长度溢出时滚动播放 | `Boolean` | `true` |
+| left-icon | 左侧图标图片 URL | `String` | - |
+| color | 文本颜色 | `String` | `#f60` |
+| background | 滚动条背景 | `String` | `#fff7cc` |
+
+### Event
+
+| 事件名 | 说明 | 参数 |
+|-----------|-----------|-----------|
+| click | 点击事件回调 | - |