Yao d471681e8f
[refactor] Popup: 升级为自定义组件 (#166)
* 封装 doc-page, 方便写文档

* add pop manager

* popup upgrade

* 更新 README

* add empty line
2018-03-25 22:30:35 +08:00

50 lines
1.5 KiB
Markdown

## Popup 轻提示
### 使用指南
在 index.json 中引入组件
```json
{
"usingComponents": {
"zan-popup": "path/to/zanui-weapp/dist/popup/index"
}
}
```
### 代码演示
可以在页面任意位置上使用 zan-popup 标签。通过 show 可以控制弹窗是否展示
```html
<zan-popup show="{{ show }}"></zan-popup>
```
#### popup 动画
popup 额外支持了 上下左右 四种动画方式,通过增加 type 属性即可控制。使用方式如下
```html
<!-- 从底部弹出的弹层 -->
<zan-popup type="bottom" show="{{ show }}"></zan-popup>
<!-- 从顶部弹出的弹层 -->
<zan-popup type="top" show="{{ show }}"></zan-popup>
<!-- 从左侧弹出的弹层 -->
<zan-popup type="left" show="{{ show }}"></zan-popup>
<!-- 从右侧弹出的弹层 -->
<zan-popup type="right" show="{{ show }}"></zan-popup>
```
### 具体参数和事件
#### 参数说明
| 参数 | 说明 | 类型 | 默认值 | 必须 |
|-----------|-----------|-----------|-------------|-------------|
| show | 是否显示弹出层 | Boolean | false | |
| overlay | 是否显示遮罩层 | Boolean | false | |
| closeOnClickOverlay | 遮罩层点击时,是否触发关闭事件 | Boolean | true | |
| type | 弹出层动画方式, 可选`center`, `left`, `right`, `top`, `bottom` | String | center | |
#### 事件说明
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
| click-overlay | 遮罩层点击触发 | |
| close | 遮罩层关闭时触发 | |