mirror of
https://github.com/youzan/vant.git
synced 2025-10-18 01:17:15 +00:00
[Improvement] Reorganize document (#1066)
This commit is contained in:
87
packages/submit-bar/en-US.md
Normal file
87
packages/submit-bar/en-US.md
Normal file
@@ -0,0 +1,87 @@
|
||||
## SubmitBar
|
||||
|
||||
### Install
|
||||
``` javascript
|
||||
import { SubmitBar } from 'vant';
|
||||
|
||||
Vue.use(SubmitBar);
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
#### Basic Usage
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
:price="3050"
|
||||
button-text="Submit"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### Disabled
|
||||
`submit` event will not triggerd when disabled.
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
disabled
|
||||
:price="3050"
|
||||
button-text="Submit"
|
||||
tip="Some tips"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### Loading
|
||||
`submit` event will not triggerd when loading.
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
loading
|
||||
:price="3050"
|
||||
button-text="Submit"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### Advanced Usage
|
||||
Use slot to add custom contents.
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
:price="3050"
|
||||
button-text="Submit"
|
||||
@submit="onSubmit"
|
||||
>
|
||||
<van-checkbox v-model="checked">Check</van-checkbox>
|
||||
<span slot="tip">
|
||||
Some tips, <span @click="onClickEditAddress">Link</span>
|
||||
</span>
|
||||
</van-submit-bar>
|
||||
```
|
||||
|
||||
### API
|
||||
|
||||
| Attribute | Description | Type | Default |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| price | Price | `Number` | - |
|
||||
| label | Price label | `String` | `合计:` |
|
||||
| button-text | Button text | `String` | - |
|
||||
| button-type | Button type | `String` | `danger` |
|
||||
| tip | Tip | `String` | - |
|
||||
| disabled | Whether to disable button | `Boolean` | `false` |
|
||||
| loading | Whether to show loading icon | `Boolean` | `false` |
|
||||
| currency | Currency symbol | `String` | `¥` |
|
||||
|
||||
### Event
|
||||
|
||||
| Event | Description | Arguments |
|
||||
|-----------|-----------|-----------|
|
||||
| submit | Triggerd when click submit button | - |
|
||||
|
||||
### Slot
|
||||
|
||||
| Name | Description |
|
||||
|-----------|-----------|
|
||||
| default | Custom left content |
|
||||
| tip | Custom tips |
|
87
packages/submit-bar/zh-CN.md
Normal file
87
packages/submit-bar/zh-CN.md
Normal file
@@ -0,0 +1,87 @@
|
||||
## SubmitBar 提交订单栏
|
||||
|
||||
### 使用指南
|
||||
``` javascript
|
||||
import { SubmitBar } from 'vant';
|
||||
|
||||
Vue.use(SubmitBar);
|
||||
```
|
||||
|
||||
### 代码演示
|
||||
|
||||
#### 基础用法
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
:price="3050"
|
||||
button-text="提交订单"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### 禁用状态
|
||||
禁用状态下不会触发`submit`事件
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
disabled
|
||||
:price="3050"
|
||||
button-text="提交订单"
|
||||
tip="您的收货地址不支持同城送, 我们已为您推荐快递"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### 加载状态
|
||||
加载状态下不会触发`submit`事件
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
loading
|
||||
:price="3050"
|
||||
button-text="提交订单"
|
||||
@submit="onSubmit"
|
||||
/>
|
||||
```
|
||||
|
||||
#### 高级用法
|
||||
通过 slot 插入自定义内容
|
||||
|
||||
```html
|
||||
<van-submit-bar
|
||||
:price="3050"
|
||||
button-text="提交订单"
|
||||
@submit="onSubmit"
|
||||
>
|
||||
<van-checkbox v-model="checked">全选</van-checkbox>
|
||||
<span slot="tip">
|
||||
您的收货地址不支持同城送, <span>修改地址</span>
|
||||
</span>
|
||||
</van-submit-bar>
|
||||
```
|
||||
|
||||
### API
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| price | 价格(单位分) | `Number` | - |
|
||||
| label | 价格文案 | `String` | `合计:` |
|
||||
| button-text | 按钮文字 | `String` | - |
|
||||
| button-type | 按钮类型 | `String` | `danger` |
|
||||
| tip | 提示文案 | `String` | - |
|
||||
| disabled | 是否禁用按钮 | `Boolean` | `false` |
|
||||
| loading | 是否显示加载中的按钮 | `Boolean` | `false` |
|
||||
| currency | 货币符号 | `String` | `¥` |
|
||||
|
||||
### Event
|
||||
|
||||
| 事件名 | 说明 | 参数 |
|
||||
|-----------|-----------|-----------|
|
||||
| submit | 按钮点击事件回调 | - |
|
||||
|
||||
### Slot
|
||||
|
||||
| 名称 | 说明 |
|
||||
|-----------|-----------|
|
||||
| default | 自定义订单栏左侧内容 |
|
||||
| tip | 提示文案中的额外操作和说明 |
|
Reference in New Issue
Block a user