[improvement] rename packages dir to src (#3659)

2019-06-27 11:25:57 +08:00
parent 8489918dca
commit 75c79b7044
619 changed files with 21 additions and 21 deletions
@@ -0,0 +1,137 @@
+# ActionSheet 上拉菜单
+
+### 引入
+``` javascript
+import { ActionSheet } from 'vant';
+
+Vue.use(ActionSheet);
+```
+
+## 代码演示
+
+### 基础用法
+
+`ActionSheet`通过`actions`数组来定义展示的选项，数组的每一项是一个对象，对象属性见文档下方表格。
+
+```html
+<van-action-sheet
+  v-model="show"
+  :actions="actions"
+  @select="onSelect"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      show: false,
+      actions: [
+        { name: '选项' },
+        { name: '选项' },
+        { name: '选项', subname: '描述信息' }
+      ]
+    };
+  },
+
+  methods: {
+    onSelect(item) {
+      // 点击选项时默认不会关闭菜单，可以手动关闭
+      this.show = false;
+      Toast(item.name);
+    }
+  }
+}
+```
+
+### 选项状态
+
+选项可以设置为加载状态或禁用状态
+
+```html
+<van-action-sheet
+  v-model="show"
+  :actions="actions"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      show: false,
+      actions: [
+        { name: '选项' },
+        { name: '选项', loading: true },
+        { name: '禁用选项', disabled: true }
+      ]
+    };
+  }
+}
+```
+
+### 展示取消按钮
+
+设置`cancelText`属性后，会在底部展示取消按钮，点击后关闭当前菜单
+
+```html
+<van-action-sheet
+  v-model="show"
+  :actions="actions"
+  cancel-text="取消"
+  @select="onSelect"
+  @cancel="onCancel"
+/>
+```
+
+### 展示标题栏
+
+通过设置`title`属性展示标题栏，同时可以使用插槽自定义菜单内容
+
+```html
+<van-action-sheet v-model="show" title="标题">
+  <p>内容</p>
+</van-action-sheet>
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| actions | 菜单选项 | `Array` | `[]` | - |
+| title | 标题 | `String` | - | - |
+| cancel-text | 取消按钮文字 | `String` | - | - |
+| overlay | 是否显示遮罩层 | `Boolean` | `true` | - |
+| close-on-click-action | 是否在点击选项后关闭 | `Boolean` | `false` | 2.0.0 |
+| close-on-click-overlay | 是否在点击遮罩层后关闭 | `Boolean` | `true` | - |
+| lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.11 |
+| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | 2.0.0 |
+| duration | 动画时长，单位秒 | `Number` | `0.3` | 2.0.3 |
+| get-container | 指定挂载的节点，可以传入选择器，<br>或一个返回节点的函数 | `String | () => HTMLElement` | - | - |
+| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 |
+
+### Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| select | 选中选项时触发，禁用或加载状态下不会触发 | item: 选项对应的对象, index: 选择对应的索引 |
+| cancel | 取消按钮点击时触发 | - |
+| click-overlay | 点击遮罩层时触发 | - |
+| open | 打开菜单时触发 | - |
+| opened | 打开菜单且动画结束后触发 | - |
+| close | 关闭菜单时触发 | - |
+| closed | 关闭菜单且动画结束后触发 | - |
+
+### actions
+
+`Props`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`：
+
+| key | 说明 |
+|------|------|
+| name | 标题 |
+| subname | 二级标题 |
+| className | 为对应列添加额外的 class |
+| loading | 是否为加载状态 |
+| disabled | 是否为禁用状态 |