mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
55 lines
1.2 KiB
Markdown
55 lines
1.2 KiB
Markdown
# Overlay 遮罩层
|
|
|
|
### 介绍
|
|
|
|
创建一个遮罩层，用于强调特定的页面元素，并阻止用户进行其他操作
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-overlay": "path/to/vant-weapp/dist/overlay/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
```html
|
|
<van-button type="primary" bind:click="onClickShow">显示遮罩层</van-button>
|
|
<van-overlay show="{{ show }}" bind:click="onClickHide"/>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
show: false
|
|
},
|
|
onClickShow() {
|
|
this.setData({ show: true });
|
|
},
|
|
onClickHide() {
|
|
this.setData({ show: false });
|
|
}
|
|
});
|
|
```
|
|
|
|
### Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|------|------|------|------|------|
|
|
| show | 是否展示遮罩层 | *boolean* | `false` | - |
|
|
| z-index | z-index 层级 | *string \| number* | `1` | - |
|
|
| duration | 动画时长，单位秒 | *string \| number* | `0.3` | - |
|
|
| class-name | 自定义类名 | *string* | - | - |
|
|
| custom-style | 自定义样式 | *string* | - | - |
|
|
|
|
### Events
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| bind:click | 点击时触发 | - |
|