弹出层 Popup
弹出层容器,用于展示弹窗等信息。提供 popup 与 popoup-titlebar 2个组件,可以单独配置。
使用
API安装使用
{
// 原生小程序
"usingComponents": {
"ti-popup": "@titian-design/weapp/popup/index",
"ti-popup-titlebar": "@titian-design/weapp/popup-titlebar/index"
},
// titan-cli搭建的项目
"usingComponents": {
"ti-popup": "platform://titian-mp/ti-popup",
"ti-popup-titlebar": "platform://titian-mp/ti-popup-titlebar"
}
}
用法示例
基本用法
<ti-popup
visible="{{ true }}"
close-on-mask="{{ true }}"
bind:close="onClose"
position="bottom"
>
<view>内容演示</view>
</ti-popup>
使用 TiPopupTitlebar
<ti-popup visible="{{true}}" close-on-mask="{{true}}" bind:close="onClose" position="bottom">
<ti-popup-titlebar
title="标题"
sub-title=副标题
confirm-text="确认"
cancel-text="取消"
variant="with-confirm"
bind:cancel={onClose}
bind:confirm={onClose}
/>
<view>内容演示</view>
</ti-popup>
滚动穿透
<ti-popup
visible="{{true}}"
close-on-mask="{{true}}"
bind:close="onClose"
position="bottom"
>
<view>阻止滚动区域</view>
<scroll-view scroll-y style="height: 100rpx;">
<view id="demo1" style="height: 200rpx;">
可滚动区域,不会穿透
</view>
</scroll-view>
</ti-popup>
ti-popup API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
mask-z-index | number | 否 | 10000 | 遮罩 z-index 层级 | - |
content-z-index | number | 否 | 10001 | 内容 z-index 层级 | - |
has-mask | boolean | 否 | true | 是否显示遮罩 | - |
visible | boolean | 否 | false | 是否显示弹出层 | - |
prevent-scroll | string | 否 | true | 是否锁定背景滚动 | - |
close-on-mask | boolean | 否 | true | 是否在点击遮罩层后关闭 | - |
timeout | number | 否 | 300 | 动画时间,默认单位为 ms | - |
timing-function | string | 否 | linear | 动画效果,即 CSS 的属性 | - |
position | string | 否 | center | 弹出位置,可选值为 top bottom right left center | - |
ext-mask-style | string | 否 | - | 自定义遮罩层样式 | - |
ext-content-style | string | 否 | - | 自定义弹出层样式 | - |
transition | string | 否 | - | 过渡动画类型 | - |
destroy-on-close | boolean | 否 | false | 关闭后是否销毁- | - |
safe-area | boolean | 否 | true | 使用底部安全栏 | - |
事件 Events
事件名 | 返回值 | 描述 |
---|---|---|
bind:show | - | 弹窗展示时触发 |
bind:close | - | 点击遮罩关闭时触发 |
bind:enter | - | 入场动画开始时触发 |
bind:entered | - | 入场动画结束时触发 |
bind:exit | - | 出场动画开始时触发 |
bind:exited | - | 出场动画结束时触发 |
插槽 Slots
名称 | 说明 | 备注 |
---|---|---|
default | 默认插槽 | - |
外部样式类 External Classes
名称 | 说明 | 备注 |
---|---|---|
ext-class | 内容区容器样式类 | - |
ext-content-class | 内容区样式类 | - |
ext-mask-class | 蒙层样式类 | - |
CSS 变量 CSS Variables
变量 | 默认值 | 说明 | 备注 |
---|---|---|---|
--popup-mask-bg-color | var(--neutral-color-1, #212121) | 蒙层背景色 | - |
--popup-mask-opacity | 0.8 | 蒙层背景色透明度 | - |
--popup-radius | @radius-16 | 内容区圆角 | - |
--popup-box-bg-color | var(--neutral-color-9, #ffffff) | 内容区背景色 | - |
--popup-vertical-width | 100% | 内容区宽度;position 为 up |bottom 时生效 | - |
--popup-vertical-min-height | 200px | 内容区最小高度;position 为 up |bottom 时生效 | - |
--popup-vertical-max-height | calc(100% - 200px) | 内容区最大高度;position 为 up |bottom 时生效 | - |
--popup-horizontal-height | 100vh | 内容区高度;position 为 left |right 时生效 | - |
--popup-horizontal-min-width | 50px | 内容区最小宽度;position 为 left |right 时生效 | - |
--popup-horizontal-max-width | 100% | 内容区最大宽度;position 为 left |right 时生效 | - |
ti-popup-titlebar API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
title | string | 否 | - | 标题 | - |
sub-title | string | 否 | - | 副标题 | - |
variant | string | 否 | with-confirm | 标题栏类型,可选值with-confirm | cancel-only |
confirm-text | string | 否 | '确定' | 确认按钮的文案 | - |
cancel-text | string | 否 | '取消' | 取消按钮的文案 | - |
ext-style | string | 否 | - | 根节点样式 | - |
variant
枚举含义:
值 | 含义 |
---|---|
back-title-cancel | 返回 + 标题 + 取消 |
with-confirm | 标题+确定+取消 |
cancel-only | 标题+关闭 |
mini-close | 仅关闭 |
事件 Events
事件名 | 返回值 | 描述 |
---|---|---|
bind:cancel | - | 对应 with-confirm 的左侧按钮点击事件 |
bind:confirm | - | 对应 with-confirm 的右侧按钮点击事件 |
bind:close | - | 对应 mini-close | cancel-only | back-title-cancel 的右侧按钮点击事件 |
bind:back | - | 对应 back-title-cancel 的左侧按钮点击事件 |
CSS 变量 CSS Variables
变量 | 默认值 | 说明 | 备注 |
---|---|---|---|
--popup-title-bar-confirm-color | rgb(var(--theme-r, 250), var(--theme-g, 44), var(--theme-b, 25)) | 确认按钮颜色 | - |
--popup-title-bar-cancel-color | var(--neutral-color-2, #757575) | 取消按钮颜色 | - |
--popup-title-bar-back-color | var(--neutral-color-2, #757575) | 返回按钮颜色 | - |
--popup-title-bar-mini-close-padding | 36px 36px 36px 0 | 关闭按钮的padding | - |