| | |
|---|
| | | --- |
|---|
| | | |
|---|
| | | <span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-100%25-blue" /></span> |
|---|
| | | |
|---|
| | | ## 引入 |
|---|
| | | |
|---|
| | | 全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。 |
|---|
| | |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | ## 代码演示 |
|---|
| | | |
|---|
| | | <a href="https://developers.weixin.qq.com/s/AB8Cvim37eS6" title="在开发者工具中预览效果" target="_blank" rel="noopener noreferrer"> 在开发者工具中预览效果 </a> |
|---|
| | | |
|---|
| | | <blockquote style="background-color: #d9e1ff; font-size: 15px; line-height: 26px;margin: 16px 0 0;padding: 16px; border-radius: 6px; color: #0052d9" > |
|---|
| | | <p>Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"</p> |
|---|
| | | </blockquote> |
|---|
| | | |
|---|
| | | ### 组件类型 |
|---|
| | | |
|---|
| | |
|---|
| | | {{ custom-close }} |
|---|
| | | |
|---|
| | | ## API |
|---|
| | | |
|---|
| | | ### Popup Props |
|---|
| | | |
|---|
| | | 名称 | 类型 | 默认值 | 说明 | 必传 |
|---|
| | | 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|
| | | -- | -- | -- | -- | -- |
|---|
| | | close-btn | Boolean / Slot | - | 关闭按钮，值类型为 Boolean 时表示是否显示关闭按钮。也可以自定义关闭按钮 | N |
|---|
| | | style | Object | - | 样式 | N |
|---|
| | | custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N |
|---|
| | | close-btn | Boolean / Slot | - | 关闭按钮，值类型为 Boolean 时表示是否显示关闭按钮。也可以自定义关闭按钮。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N |
|---|
| | | close-on-overlay-click | Boolean | true | 点击遮罩层是否关闭 | N |
|---|
| | | content | String / Slot | - | 浮层里面的内容 | N |
|---|
| | | content | String / Slot | - | 浮层里面的内容。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N |
|---|
| | | default-visible | Boolean | - | 是否显示浮层。非受控属性。TS 类型：`boolean` | N |
|---|
| | | duration | Number | 240 | 动画过渡时间 | N |
|---|
| | | external-classes | Array | - | 组件类名，分别用于设置 组件外层元素、遮罩层、浮层内容 等元素类名。`['t-class', 't-class-overlay', 't-class-content']` | N |
|---|
| | | overlay-props | Object | {} | 遮罩层的属性，透传至 overlay | N |
|---|
| | | overlay-props | Object | {} | 遮罩层的属性，透传至 overlay。TS 类型：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/popup/type.ts) | N |
|---|
| | | placement | String | top | 浮层出现位置。可选项：top/left/right/bottom/center | N |
|---|
| | | prevent-scroll-through | Boolean | true | 防止滚动穿透 | N |
|---|
| | | show-overlay | Boolean | true | 是否显示遮罩层 | N |
|---|
| | | using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N |
|---|
| | | visible | Boolean | false | 是否显示浮层。TS 类型：`boolean` | N |
|---|
| | | default-visible | Boolean | undefined | 是否显示浮层。非受控属性。TS 类型：`boolean` | N |
|---|
| | | z-index | Number | 11500 | 组件层级，Web 侧样式默认为 5500，移动端样式默认为 1500，小程序样式默认为11500 | N |
|---|
| | |
|---|
| | | 名称 | 参数 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | visible-change | `(visible: boolean, trigger: PopupSource) ` | 当浮层隐藏或显示时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/popup/type.ts)。<br/>`type PopupSource = 'close-btn' \| 'overlay'`<br/> |
|---|
| | | ### Popup External Classes |
|---|
| | | |
|---|
| | | 类名 | 描述 |
|---|
| | | -- | -- |
|---|
| | | t-class | 根节点样式类 |
|---|
| | | t-class-content | 内容样式类 |
|---|
| | | |
|---|
| | | ### CSS Variables |
|---|
| | | |
|---|
| | | 组件提供了下列 CSS 变量，可用于自定义样式。 |
|---|
| | | 名称 | 默认值 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | --td-popup-bg-color | @bg-color-container | - |
|---|
| | | --td-popup-border-radius | @radius-default | - |
|---|
| | | --td-popup-close-btn-color | @text-color-primary | - |
|---|
