Files
akmon/uni_modules/lime-overlay/readme.md
2026-01-20 08:04:15 +08:00

2.7 KiB
Raw Permalink Blame History

lime-overlay 遮罩层

  • 通过遮罩层,可以强调部分内容
  • 插件依赖lime-style,lime-shared,lime-transition,不喜勿下

安装

在插件市场导入即可,首次安装可能需要重新编译

代码演示

基础用法

<button @click="onClick">显示</button>
<l-overlay :visible="show" @click="onClick"></l-overlay>
const show = ref(false);
const onClick = () => {
	show.value = !show.value
}

嵌入内容

通过默认插槽可以在遮罩层上嵌入任意内容。

<button @click="onClick">显示</button>
<l-overlay :visible="show" @click="onClick">
	<view class="wrapper">
		<view class="block" />
	</view>
</l-overlay>
const show = ref(false);
const onClick = () => {
	show.value = !show.value
}

查看示例

  • 导入后直接使用这个标签查看演示效果
<!-- // 代码位于 uni_modules/lime-overlay/compoents/lime-overlay -->
<lime-overlay />

插件标签

  • 默认 l-overlay 为 component
  • 默认 lime-overlay 为 demo

关于vue2的使用方式

  • 插件使用了composition-api, 如果你希望在vue2中使用请按官方的教程vue-composition-api配置
  • 关键代码是: 在main.js中 在vue2部分加上这一段即可
// vue2
import Vue from 'vue'
import VueCompositionAPI from '@vue/composition-api'
Vue.use(VueCompositionAPI)

API

Props

参数 说明 类型 默认值
visible 是否展示遮罩层 boolean false
z-index z-index 层级 number 1000
duration 动画时长单位ms设置为 0 可以禁用动画 number 300
lStyle 样式 string ``
destoryOnClose 隐藏时是否销毁 boolean false

Events

事件名 说明 回调参数
click 点击时触发 -

Slots

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

主题定制

样式变量

组件提供了下列 CSS 变量可用于自定义样式uvue app无效。

名称 默认值 描述
--l-overlay-z-index 1000 -
--l-overlay-background rgba(0, 0, 0, 0.6) -

打赏

如果你觉得本插件,解决了你的问题,赠人玫瑰,手留余香。