Files
HuajisheTools/HuajisheCheckChaoXing/miniprogram_npm/tdesign-miniprogram/overlay/README.md
2025-10-01 10:01:52 +08:00

2.8 KiB
Raw Blame History

title, description, spline, isComponent
title description spline isComponent
Overlay 遮罩层 通过遮罩层,可以强调部分内容 message true

该组件于 0.10.0 版本上线,请留意版本。

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-overlay": "tdesign-miniprogram/overlay/overlay"
}

代码演示

在开发者工具中预览效果

Tips: 请确保开发者工具为打开状态。导入开发者工具后依次执行npm i > 构建npm包 > 勾选 "将JS编译成ES5"

基础使用

{{ base }}

API

Overlay Props

名称 类型 默认值 描述 必传
style Object - 样式 N
custom-style Object - 样式,一般用于开启虚拟化组件节点场景 N
background-color String - 遮罩层的背景色 N
duration Number 300 背景色过渡时间,单位毫秒 N
prevent-scroll-through Boolean true 防止滚动穿透,即不允许点击和滚动 N
using-custom-navbar Boolean false 是否使用了自定义导航栏 N
visible Boolean false 是否展示 N
z-index Number 11000 遮罩层级 N

Overlay Events

名称 参数 描述
click ({ visible: boolean }) 点击遮罩时触发

CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。

名称 默认值 描述
--td-overlay-bg-color @font-gray-2 -
--td-overlay-transition-duration 300ms -