Skip to content

Overlay 遮罩层

创建一个遮罩层,用于强调特定的页面元素,并阻止用户进行其他操作。

基础用法

嵌入内容

API

Props

参数说明类型默认值
show是否展示遮罩层booleanfalse
z-indexz-index 层级number | string1
duration动画时长,单位秒,设置为 0 可以禁用动画number | string0.3
class-name自定义类名string-
custom-style自定义样式object-
lock-scroll是否锁定背景滚动,锁定时蒙层里的内容也将无法滚动booleantrue
lazy-render是否在显示时才渲染节点booleantrue
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-

Events

事件名说明回调参数
click点击时触发event: MouseEvent

Slots

名称说明
default默认插槽,用于在遮罩层上方嵌入内容

类型定义

组件导出以下类型定义:

ts
import type { OverlayProps } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-overlay-z-index1-
--r-overlay-backgroundrgba(0, 0, 0, 0.7)-

Released under the MIT License.