blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-24 18:36:51 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] add Popup english document

Browse Source
This commit is contained in:
陈嘉涵 2017-10-19 19:45:57 +08:00
parent 14de879a3b
commit a2f4a4ed83
48 changed files with 287 additions and 322 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/examples-docs/en-US/image-preview.md
View File

@ -45,7 +45,7 @@ export default {
``` ```
::: :::
### 方法参数 ### Arguments
| Attribute | Description | Type | | Attribute | Description | Type |
|-----------|-----------|-----------| |-----------|-----------|-----------|

87
docs/examples-docs/en-US/popup.md
View File

@ -4,19 +4,18 @@ import Dialog from 'packages/dialog';
export default { export default {
data() { data() {
return { return {
popupShow1: false, show1: false,
popupShow2: false, show2: false,
popupShow3: false, show3: false,
popupShow4: false, show4: false
popupShow5: false
} }
}, },
watch: { watch: {
popupShow3(val) { show3(val) {
if (val) { if (val) {
setTimeout(() => { setTimeout(() => {
this.popupShow3 = false; this.show3 = false;
}, 2000); }, 2000);
} }
} }
@ -27,11 +26,7 @@ export default {
Dialog.confirm({ Dialog.confirm({
title: 'confirm标题', title: 'confirm标题',
message: '弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。' message: '弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。'
}).then((action) => { })
console.log(action);
}, (error) => {
console.log(error);
});
} }
} }
}; };
@ -49,53 +44,41 @@ Vue.component(Popup.name, Popup);
### Usage ### Usage
#### Basic Usage #### Basic Usage
Popup is located in the middle of the screen by default
`popup`默认情况下是从中间弹出。
:::demo Basic Usage :::demo Basic Usage
```html ```html
<van-button @click="popupShow1 = true">从中间弹出popup</van-button> <van-button @click="show1 = true">Show Popup</van-button>
<van-popup v-model="popupShow1" class="van-popup-1" :lock-on-scroll="true"> <van-popup v-model="show1">Content</van-popup>
从中间弹出popup
</van-popup>
``` ```
```javascript ```javascript
export default { export default {
data() { data() {
return { return {
popupShow1: false show1: false
} }
} }
}; };
``` ```
::: :::
#### 从不同位置弹出层 #### Different Position
Use `position` prop to set popup display position
可以设置`position`属性，`popup`即能从不同位置弹出，`position`的可选值有`top`，`bottom`，`right`，`left`。 :::demo Different Position
:::demo 从不同位置弹出层
```html ```html
<van-button @click="popupShow2 = true;">从下方弹出popup</van-button> <van-button @click="show2 = true;">From Bottom</van-button>
<van-popup v-model="popupShow2" position="bottom" class="van-popup-2"> <van-popup v-model="show2" position="bottom">
<van-button @click="showDialog">弹出dialog</van-button> <van-button @click="showDialog">Show Dialog</van-button>
</van-popup> </van-popup>
<van-button @click="popupShow3 = true">从上方弹出popup</van-button> <van-button @click="show3 = true">From Top</van-button>
<van-popup v-model="popupShow3" position="top" class="van-popup-3" :overlay="false"> <van-popup v-model="show3" position="top" :overlay="false">Content</van-popup>
更新成功
</van-popup>
<van-button @click="popupShow4 = true">从右方弹出popup</van-button> <van-button @click="show4 = true">From Right</van-button>
<van-popup v-model="popupShow4" position="right" class="van-popup-4" :overlay="false"> <van-popup v-model="show4" position="right" :overlay="false">
<van-button @click.native="popupShow4 = false">关闭 popup</van-button> <van-button @click="show4 = false">Close</van-button>
</van-popup>
<van-button @click="popupShow5 = true">从左方弹出popup</van-button>
<van-popup v-model="popupShow5" position="left" class="van-popup-5" :overlay="false">
<van-button @click.native="popupShow5 = false">关闭 popup</van-button>
</van-popup> </van-popup>
``` ```
@ -103,18 +86,18 @@ export default {
export default { export default {
data() { data() {
return { return {
popupShow1: false, show1: false,
popupShow2: false, show2: false,
popupShow3: false, show3: false,
popupShow4: false show4: false
} }
}, },
watch: { watch: {
popupShow2(val) { show2(val) {
if (val) { if (val) {
setTimeout(() => { setTimeout(() => {
this.popupShow2 = false; this.show2 = false;
}, 2000); }, 2000);
} }
} }
@ -127,10 +110,10 @@ export default {
| Attribute | Description | Type | Default | Accepted Values | | Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------| |-----------|-----------|-----------|-------------|-------------|
| v-model | 当前组件是否显示 | `Boolean` | `false` | - | | v-model | Whether to show popup | `Boolean` | `false` | - |
| overlay | 是否显示背景遮罩层 | `Boolean` | `true` | - | | overlay | Whether to show overlay | `Boolean` | `true` | - |
| lockOnScroll | 背景是否跟随滚动 | `Boolean` | `false` | - | | lockOnScroll | Lock body scroll | `Boolean` | `false` | - |
| position | 弹出层位置 | `String` | - | `top`, `bottom`, `right`, `left` | | position | Position | `String` | - | `top` `bottom` `right` `left` |
| closeOnClickOverlay | 点击遮罩层是否关闭弹出层 | `Boolean` | `true` | - | | closeOnClickOverlay | Close popup when click overlay | `Boolean` | `true` | - |
| transition | 弹出层的`transition` | `String` | `popup-slide` | | | transition | Transition | `String` | `popup-slide` | |
| preventScroll | 是否防止滚动穿透 | `Boolean` | `false` | - | | preventScroll | Prevent background scroll | `Boolean` | `false` | - |

98
docs/examples-docs/zh-CN/popup.md
View File

@ -1,36 +1,34 @@
<style> <style>
.demo-popup { .demo-popup {
.van-button { .van-button {
margin: 10px 15px; margin: 10px 0 10px 15px;
} }
.van-popup-1 { .van-popup {
width: 60%; width: 60%;
box-sizing: border-box;
padding: 20px; padding: 20px;
border-radius: 5px; border-radius: 5px;
text-align: center; box-sizing: border-box;
}
.van-popup-2 { &--bottom {
width: 100%; width: 100%;
height: 200px; height: 200px;
box-sizing: border-box;
padding: 20px;
} }
.van-popup-3 { &--top {
line-height: 50px;
text-align: center;
background-color: rgba(0, 0, 0, 0.701961);
color: #fff; color: #fff;
width: 100%;
border-radius: 0;
line-height: 20px;
background-color: rgba(0, 0, 0, 0.8);
} }
.van-popup-4, &--left,
.van-popup-5 { &--right {
width: 100%; width: 100%;
height: 100%; height: 100%;
} }
}
} }
</style> </style>
@ -40,19 +38,18 @@ import Dialog from 'packages/dialog';
export default { export default {
data() { data() {
return { return {
popupShow1: false, show1: false,
popupShow2: false, show2: false,
popupShow3: false, show3: false,
popupShow4: false, show4: false
popupShow5: false
} }
}, },
watch: { watch: {
popupShow3(val) { show3(val) {
if (val) { if (val) {
setTimeout(() => { setTimeout(() => {
this.popupShow3 = false; this.show3 = false;
}, 2000); }, 2000);
} }
} }
@ -63,11 +60,7 @@ export default {
Dialog.confirm({ Dialog.confirm({
title: 'confirm标题', title: 'confirm标题',
message: '弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。' message: '弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。弹窗提示文字，左右始终距离边20PX，上下距离20PX，文字左对齐。'
}).then((action) => { })
console.log(action);
}, (error) => {
console.log(error);
});
} }
} }
}; };
@ -85,53 +78,43 @@ Vue.component(Popup.name, Popup);
### 代码演示 ### 代码演示
#### 基础用法 #### 基础用法
`popup`默认从中间弹出
`popup`默认情况下是从中间弹出。
:::demo 基础用法 :::demo 基础用法
```html ```html
<van-button @click="popupShow1 = true">从中间弹出popup</van-button> <van-button @click="show1 = true">弹出 Popup</van-button>
<van-popup v-model="popupShow1" class="van-popup-1" :lock-on-scroll="true"> <van-popup v-model="show1">内容</van-popup>
从中间弹出popup
</van-popup>
``` ```
```javascript ```javascript
export default { export default {
data() { data() {
return { return {
popupShow1: false show1: false
} }
} }
}; };
``` ```
::: :::
#### 从不同位置弹出层 #### 弹出位置
通过`position`属性设置 Popup 弹出位置
可以设置`position`属性，`popup`即能从不同位置弹出，`position`的可选值有`top`，`bottom`，`right`，`left`。 :::demo 弹出位置
:::demo 从不同位置弹出层
```html ```html
<van-button @click="popupShow2 = true;">从下方弹出popup</van-button> <van-button @click="show2 = true;">底部弹出</van-button>
<van-popup v-model="popupShow2" position="bottom" class="van-popup-2"> <van-popup v-model="show2" position="bottom">
<van-button @click="showDialog">弹出dialog</van-button> <van-button @click="showDialog">弹出 Dialog</van-button>
</van-popup> </van-popup>
<van-button @click="popupShow3 = true">从上方弹出popup</van-button> <van-button @click="show3 = true">顶部弹出</van-button>
<van-popup v-model="popupShow3" position="top" class="van-popup-3" :overlay="false"> <van-popup v-model="show3" position="top" :overlay="false">
更新成功 更新成功
</van-popup> </van-popup>
<van-button @click="popupShow4 = true">从右方弹出popup</van-button> <van-button @click="show4 = true">右侧弹出</van-button>
<van-popup v-model="popupShow4" position="right" class="van-popup-4" :overlay="false"> <van-popup v-model="show4" position="right" :overlay="false">
<van-button @click.native="popupShow4 = false">关闭 popup</van-button> <van-button @click="show4 = false">关闭弹层</van-button>
</van-popup>
<van-button @click="popupShow5 = true">从左方弹出popup</van-button>
<van-popup v-model="popupShow5" position="left" class="van-popup-5" :overlay="false">
<van-button @click.native="popupShow5 = false">关闭 popup</van-button>
</van-popup> </van-popup>
``` ```
@ -139,18 +122,17 @@ export default {
export default { export default {
data() { data() {
return { return {
popupShow1: false, show1: false,
popupShow2: false, show2: false,
popupShow3: false, show3: false
popupShow4: false
} }
}, },
watch: { watch: {
popupShow2(val) { show2(val) {
if (val) { if (val) {
setTimeout(() => { setTimeout(() => {
this.popupShow2 = false; this.show2 = false;
}, 2000); }, 2000);
} }
} }
@ -166,7 +148,7 @@ export default {
| v-model | 当前组件是否显示 | `Boolean` | `false` | - | | v-model | 当前组件是否显示 | `Boolean` | `false` | - |
| overlay | 是否显示背景遮罩层 | `Boolean` | `true` | - | | overlay | 是否显示背景遮罩层 | `Boolean` | `true` | - |
| lockOnScroll | 背景是否跟随滚动 | `Boolean` | `false` | - | | lockOnScroll | 背景是否跟随滚动 | `Boolean` | `false` | - |
| position | 弹出层位置 | `String` | - | `top`, `bottom`, `right`, `left` | | position | 弹出层位置 | `String` | - | `top` `bottom` `right` `left` |
| closeOnClickOverlay | 点击遮罩层是否关闭弹出层 | `Boolean` | `true` | - | | closeOnClickOverlay | 点击遮罩层是否关闭弹出层 | `Boolean` | `true` | - |
| transition | 弹出层的`transition` | `String` | `popup-slide` | | | transition | 弹出层的`transition` | `String` | `popup-slide` | |
| preventScroll | 是否防止滚动穿透 | `Boolean` | `false` | - | | preventScroll | 是否防止滚动穿透 | `Boolean` | `false` | - |