2018-08-13 15:02:15 +08:00

68 lines
1.3 KiB
Markdown

## Popup 弹出层
### 使用指南
在 index.json 中引入组件
```json
"usingComponents": {
"van-popup": "path/to/vant-weapp/dist/popup/index"
}
```
### 代码演示
#### 基础用法
`popup`默认从中间弹出
```html
<van-popup show="{{ show }}" bind:close="onClose">内容</van-popup>
```
```javascript
Page({
data: {
show: false
},
onClose() {
this.setData({ show: false });
}
});
```
#### 弹出位置
通过`position`属性设置 Popup 弹出位置
```html
<van-popup
show="{{ show }}"
position="top"
overlay="{{ false }}"
bind:close="onClose"
>
内容
</van-popup>
```
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| show | 当前组件是否显示 | `Boolean` | `false` |
| overlay | 是否显示背景蒙层 | `Boolean` | `true` |
| position | 可选值为 `top` `bottom` `right` `left` | `String` | - |
| overlay-style | 自定义蒙层样式 | `Object` | `` |
| close-on-click-overlay | 点击蒙层是否关闭 Popup | `Boolean` | `true` |
### Event
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
| bind:close | 蒙层关闭时触发 | - |
| bind:click-overlay | 点击蒙层时触发 | - |
### 外部样式类
| 类名 | 说明 |
|-----------|-----------|
| custom-class | 根节点样式类 |
| overlay-class | 蒙层样式类 |