[Doc] Popup: add get-container demo (#3522)

This commit is contained in:
neverland 2019-06-15 16:25:51 +08:00 committed by GitHub
parent 1a91bc07cd
commit 493639a4a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 209 additions and 135 deletions

View File

@ -3,81 +3,86 @@
<demo-block :title="$t('basicUsage')">
<van-button
type="primary"
@click="show1 = true"
@click="showBasic = true"
>
{{ $t('button1') }}
</van-button>
<van-popup v-model="show1">{{ $t('content') }}</van-popup>
</demo-block>
<demo-block :title="$t('position')">
<van-button
type="primary"
@click="show2 = true"
>
{{ $t('button2') }}
</van-button>
<van-popup
v-model="show2"
position="bottom"
>
<van-picker
show-toolbar
:columns="$t('columns')"
@confirm="show2 = false"
@cancel="show2 = false"
/>
</van-popup>
<van-button
type="primary"
@click="show3 = true"
>
{{ $t('button4') }}
{{ $t('buttonBasic') }}
</van-button>
<van-popup
v-model="show3"
position="top"
:overlay="false"
v-model="showBasic"
:style="{ padding: '30px 50px' }"
>
{{ $t('content') }}
</van-popup>
</demo-block>
<demo-block :title="$t('position')">
<van-row>
<van-button
type="primary"
@click="showTop = true"
>
{{ $t('buttonTop') }}
</van-button>
<van-popup
v-model="showTop"
position="top"
:style="{ height: '20%' }"
/>
<van-button
type="primary"
@click="showBottom = true"
>
{{ $t('buttonBottom') }}
</van-button>
<van-popup
v-model="showBottom"
position="bottom"
:style="{ height: '20%' }"
/>
</van-row>
<van-button
type="primary"
@click="show4 = true"
@click="showLeft = true"
>
{{ $t('button5') }}
{{ $t('buttonLeft') }}
</van-button>
<van-popup
v-model="showLeft"
position="left"
:style="{ width: '20%', height: '100%' }"
/>
<van-button
type="primary"
@click="showRight = true"
>
{{ $t('buttonRight') }}
</van-button>
<van-popup
v-model="showRight"
position="right"
:style="{ width: '20%', height: '100%' }"
/>
</demo-block>
<demo-block :title="$t('getContainer')">
<van-button
type="primary"
@click="showGetContainer = true"
>
{{ $t('getContainer') }}
</van-button>
<van-popup
v-model="show4"
position="right"
>
<van-button
type="primary"
@click="show4 = false"
>
{{ $t('button6') }}
</van-button>
<van-button
type="primary"
@click="show5 = true"
>
{{ $t('button5') }}
</van-button>
<van-popup
v-model="show5"
position="right"
>
<van-button
type="primary"
@click="show5 = false"
>
{{ $t('button6') }}
</van-button>
</van-popup>
</van-popup>
v-model="showGetContainer"
get-container="body"
:style="{ padding: '30px 50px' }"
/>
</demo-block>
</demo-section>
</template>
@ -87,44 +92,33 @@ export default {
i18n: {
'zh-CN': {
position: '弹出位置',
button1: '弹出 Popup',
button2: '底部弹出',
button3: '弹出 Dialog',
button4: '顶部弹出',
button5: '右侧弹出',
button6: '关闭弹层',
columns: ['杭州', '宁波', '温州', '嘉兴', '湖州']
buttonBasic: '展示弹出层',
buttonTop: '顶部弹出',
buttonBottom: '底部弹出',
buttonLeft: '左侧弹出',
buttonRight: '右侧弹出',
getContainer: '指定挂载节点'
},
'en-US': {
position: 'Position',
button1: 'Show Popup',
button2: 'From Bottom',
button3: 'Show Dialog',
button4: 'From Top',
button5: 'From Right',
button6: 'Close Popup',
columns: ['Delaware', 'Florida', 'Georqia', 'Indiana', 'Maine']
buttonBasic: 'Show Popup',
buttonTop: 'From Top',
buttonBottom: 'From Bottom',
buttonLeft: 'From Left',
buttonRight: 'From Right',
getContainer: 'Get Container'
}
},
data() {
return {
show1: false,
show2: false,
show3: false,
show4: false,
show5: false
showBasic: false,
showTop: false,
showBottom: false,
showLeft: false,
showRight: false,
showGetContainer: false
};
},
watch: {
show3(val) {
if (val) {
setTimeout(() => {
this.show3 = false;
}, 2000);
}
}
}
};
</script>
@ -133,35 +127,12 @@ export default {
@import '../../style/var';
.demo-popup {
.van-row {
margin-bottom: 15px;
}
.van-button {
margin-left: 15px;
}
.van-popup {
box-sizing: border-box;
padding: 20px;
&--center {
width: 60%;
}
&--bottom {
width: 100%;
padding: 0;
}
&--top {
width: 100%;
color: @white;
line-height: 20px;
background-color: rgba(0, 0, 0, 0.8);
}
&--left,
&--right {
width: 100%;
height: 100%;
}
}
}
</style>

View File

@ -12,9 +12,11 @@ Vue.use(Popup);
### Basic Usage
Popup is located in the middle of the screen by default
```html
<van-botton type="primary" @click="showPopup">
Show Popup
</van-button>
<van-popup v-model="show">Content</van-popup>
```
@ -24,6 +26,12 @@ export default {
return {
show: false
}
},
methods: {
showPopup() {
this.show = true;
}
}
};
```
@ -33,9 +41,45 @@ export default {
Use `position` prop to set popup display position
```html
<van-popup v-model="show" position="top" :overlay="false">
Content
</van-popup>
<van-popup
v-model="show"
position="top"
:style="{ height: '20%' }"
/>
```
### Get Container
Use `get-container` prop to specify mount location
```html
<!-- mount to body -->
<van-popup
v-model="show"
get-container="body"
/>
<!-- mount to #app -->
<van-popup
v-model="show"
get-container="#app"
/>
<!-- Specify the mount location by function -->
<van-popup
v-model="show"
:get-container="getContainer"
/>
```
```js
export default {
methods: {
getContainer() {
return document.querySelector('.my-container');
}
}
}
```
## API

View File

@ -3,20 +3,28 @@
exports[`renders demo correctly 1`] = `
<div>
<div><button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
弹出 Popup
展示弹出层
</span></button>
<!---->
</div>
<div><button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
底部弹出
</span></button>
<!----> <button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
顶部弹出
<div>
<div class="van-row"><button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
顶部弹出
</span></button>
<!----> <button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
底部弹出
</span></button>
<!---->
</div> <button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
左侧弹出
</span></button>
<!----> <button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
右侧弹出
</span></button>
<!---->
</div>
<div><button class="van-button van-button--primary van-button--normal"><span class="van-button__text">
指定挂载节点
</span></button> </div>
</div>
`;

View File

@ -1,5 +1,9 @@
# Popup 弹出层
### 介绍
弹出层容器,用于展示弹窗、信息提示等内容,支持多个弹出层叠加展示
### 引入
``` javascript
@ -12,9 +16,13 @@ Vue.use(Popup);
### 基础用法
`Popup`默认从中间弹出
通过`v-model`控制弹出层是否展示
```html
<van-botton type="primary" @click="showPopup">
展示弹出层
</van-button>
<van-popup v-model="show">内容</van-popup>
```
@ -24,18 +32,61 @@ export default {
return {
show: false
}
},
methods: {
showPopup() {
this.show = true;
}
}
};
```
### 弹出位置
通过`position`属性设置`Popup`弹出位置
通过`position`属性设置弹出位置,默认居中弹出,可以设置为`top``bottom``left``right`
```html
<van-popup v-model="show" position="top" :overlay="false">
内容
</van-popup>
<van-popup
v-model="show"
position="top"
:style="{ height: '20%' }"
/>
```
### 指定挂载位置
弹出层默认挂载到组件所在位置,可以通过`get-container`属性指定挂载位置
```html
<!-- 挂载到 body 节点下 -->
<van-popup
v-model="show"
get-container="body"
/>
<!-- 挂载到 #app 节点下 -->
<van-popup
v-model="show"
get-container="#app"
/>
<!-- 通过函数指定挂载位置 -->
<van-popup
v-model="show"
:get-container="getContainer"
/>
```
```js
export default {
methods: {
// 返回一个特定的 DOM 节点,作为挂载的父节点
getContainer() {
return document.querySelector('.my-container');
}
}
}
```
## API