[Doc] rename component README file (#3662)

2019-06-27 14:22:40 +08:00
parent a56f96c246
commit ddb24e6762
119 changed files with 4 additions and 3 deletions
@@ -0,0 +1,123 @@
+# SwipeCell
+
+### Install
+
+``` javascript
+import { SwipeCell } from 'vant';
+
+Vue.use(SwipeCell);
+```
+
+## Usage
+
+### Basic Usage
+
+```html
+<van-swipe-cell :right-width="65" :left-width="65">
+  <van-button
+    square
+    slot="left"
+    type="danger"
+    text="Select"
+  />
+  <van-cell
+    :border="false"
+    title="Cell"
+    value="Cell Content"
+  />
+  <van-button
+    square
+    slot="right"
+    type="danger"
+    text="Delete"
+  />
+</van-swipe-cell>
+```
+
+### Async close
+
+```html
+<van-swipe-cell :right-width="65" :left-width="65" :on-close="onClose">
+  <van-button
+    square
+    slot="left"
+    type="danger"
+    text="Select"
+  />
+  <van-cell
+    :border="false"
+    title="Cell"
+    value="Cell Content"
+  />
+  <van-button
+    square
+    slot="right"
+    type="danger"
+    text="Delete"
+  />
+</van-swipe-cell>
+```
+
+```js
+export default {
+  methods: {
+    onClose(clickPosition, instance) {
+      switch (clickPosition) {
+        case 'left':
+        case 'cell':
+        case 'outside':
+          instance.close();
+          break;
+        case 'right':
+          Dialog.confirm({
+            message: 'Are you sure to delete?'
+          }).then(() => {
+            instance.close();
+          });
+          break;
+      }
+    }
+  }
+}
+```
+
+## API
+
+### Props
+
+| Attribute | Description | Type | Default |
+|------|------|------|------|
+| on-close | Callback function before close | `Function` | - |
+| disabled | Whether to disabled swipe | `Boolean` | `false` |
+| left-width | Width of the left swipe area | `Number` | `auto` |
+| right-width | Width of the right swipe area | `Number` | `auto` |
+
+### Slots
+
+| Name | Description |
+|------|------|
+| default | custom content |
+| left | content of left scrollable area |
+| right | content of right scrollabe area |
+
+### Events
+
+| Event | Description | Arguments |
+|------|------|------|
+| click | Triggered when clicked | Click positon (`left` `right` `cell` `outside`) |
+
+### onClose Params
+
+| Argument | Type | Description |
+|------|------|------|
+| clickPosition | `String` | Click positon (`left` `right` `cell` `outside`) |
+| instance | `Object` | SwipeCell instance |
+
+### Methods
+
+Use ref to get SwipeCell instance and call instance methods
+
+| Name | Attribute | Return value | Description |
+|------|------|------|------|
+| open | position: 'left' \| 'right' | - | open SwipeCell |
+| close | - | - | close SwipeCell |