[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,56 @@
+## Popup
+
+### Install
+``` javascript
+import { Popup } from 'vant';
+
+Vue.use(Popup);
+```
+
+### Usage
+
+#### Basic Usage
+Popup is located in the middle of the screen by default
+
+```html
+<van-popup v-model="show">Content</van-popup>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      show: false
+    }
+  }
+};
+```
+
+#### Position
+Use `position` prop to set popup display position
+
+```html
+<van-popup v-model="show" position="top" :overlay="false">
+  Content
+</van-popup>
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| v-model | Whether to show popup | `Boolean` | `false` |
+| overlay | Whether to show overlay | `Boolean` | `true` |
+| position | Can be set to `top` `bottom` `right` `left` | `String` | - |
+| overlay-class | Custom overlay class | `String` | `` |
+| overlay-style | Custom overlay style | `Object` | - |
+| close-on-click-overlay | Close popup when click overlay | `Boolean` | `true` |
+| transition | Transition | `String` | `popup-slide` |
+| lock-scroll | Whether to lock background scroll | `Boolean` | `true` |
+| get-container | Return the mount node for Popup | `() => HTMLElement` | - |
+
+### Event
+
+| Event | Description | Arguments |
+|-----------|-----------|-----------|
+| click-overlay | Triggered when click overlay | - |
@@ -0,0 +1,56 @@
+## Popup 弹出层
+
+### 使用指南
+``` javascript
+import { Popup } from 'vant';
+
+Vue.use(Popup);
+```
+
+### 代码演示
+
+#### 基础用法
+`popup`默认从中间弹出
+
+```html
+<van-popup v-model="show">内容</van-popup>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      show: false
+    }
+  }
+};
+```
+
+#### 弹出位置
+通过`position`属性设置 Popup 弹出位置
+
+```html
+<van-popup v-model="show" position="top" :overlay="false">
+  内容
+</van-popup>
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| v-model | 当前组件是否显示 | `Boolean` | `false` |
+| overlay | 是否显示背景蒙层 | `Boolean` | `true` |
+| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` |
+| position | 可选值为 `top` `bottom` `right` `left` | `String` | - |
+| overlay-class | 自定义蒙层 class | `String` | `` |
+| overlay-style | 自定义蒙层样式 | `Object` | `` |
+| close-on-click-overlay | 点击蒙层是否关闭 Popup | `Boolean` | `true` |
+| transition | transition 名称 | `String` | `popup-slide` |
+| get-container | 指定弹出层挂载的 HTML 节点 | `() => HTMLElement` | - |
+
+### Event
+
+| 事件名 | 说明 | 参数 |
+|-----------|-----------|-----------|
+| click-overlay | 点击蒙层时触发 | - |