npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vue3-popup-layer

v1.2.0

Published

用于创建一个可以弹出的弹窗页面或者组件,组合式函数实现了弹窗的核心逻辑,包括打开/关闭、历史状态管理、z-index 自动获取等功能,提供了一个功能完备的弹窗解决方案

Downloads

12

Readme

Vue 3 PopupLayer

用于创建一个可以弹出的弹窗页面或者组件,组合式函数实现了弹窗的核心逻辑,包括打开/关闭、历史状态管理、z-index 自动获取等功能,提供了一个功能完备的弹窗解决方案

使用

   <!-- 组件 -->
   <Popup v-model:visible="visible" :animation="true" :auto-index="true" ref="popupRef" >
      <div>
         <button @click="popupRef.closePopup()">返回上一页 </button>
         页面
      </div>
      
   </Popup>


   import {Popup} from 'vue3-popuplayer'

   const visible = ref(false)
   const showAbout = () => {
      popupRef.value.openPopup()
   }
   

属性部分

  • visible(boolear): 控制弹窗是否可见,布尔类型.
  • animation(boolear): 控制是否启用动画效果,布尔类型.
  • zIndex(number): 设置弹窗层的 z-index 值.
  • autoIndex(boolear): 是否自动获取最大 z-index 值.
  • getNode(boolear): 获取弹窗挂载的节点.
  • extra: 额外传递的参数对象.
  • isAsync(boolear): 是否为异步组件.
  • @onClose: 关闭时的回调方法
  • @onOpen:打开时回调方法

本地存储操作

定义了一个 store 函数,用于封装与indexedDB相关的操作,包括获取、更新、重置等。这里使用了indexedDB来记录弹窗的历史状态.IndexedDB是一种浏览器内置的非关系型数据库,存储空间更大(较新浏览器可达1GB),支持结构化数据存储

打开弹窗

show 函数用于打开弹窗,它执行以下操作:

将弹窗的 id 推入浏览器历史状态 将弹窗的 id 推入本地存储的历史记录 触发 onOpen 事件,通知外部弹窗已打开

关闭弹窗

hide 函数用于关闭弹窗,它根据用户的操作方式 (点击物理返回键或点击按钮) 执行不同的逻辑:

如果是点击物理返回键,则只需还原 isSynced 状态 如果是点击按钮,则触发 onClose 事件,从indexedDB和浏览器历史状态中删除相应的记录,并执行 history.back() 操作

关闭弹窗 (另一种方式)

closePopup 函数提供了另一种关闭弹窗的方式,它触发 update:visible 事件,通知外部组件改变 visible 的值。

获取最大 z-index

getMaxZIndex 函数用于获取页面中所有 DOM 元素的最大 z-index 值,以便为弹窗设置合适的 z-index。

返回到指定层级

backLvBy 函数用于通过条件返回到指定层级,它接受三个参数:

  • targetLv: 目标层级
  • totalLv: 总层级数
  • callBack: 回调函数,在每个层级都会执行

监听 props 变化

使用 watch 函数监听 visible 和 isAsync 两个 prop 的变化:

  • 当 visible 变化时,调用 show 或 hide 函数,并添加或移除 popstate 事件监听器
  • 当 isAsync 变化时,如果为 false,则重置本地存储的历史记录

卸载时清理

在组件卸载时,使用 onUnmounted 钩子移除 popstate 事件监听器。

浏览器历史状态变化监听器 listener 函数是一个事件监听器,它监听浏览器历史状态的变化 (popstate 事件)。当用户点击物理返回键时,它会执行以下操作:

获取当前的浏览器历史状态 ID 和indexedDB的历史记录

如果当前的返回事件 ID 与最后一个弹窗 ID 匹配,则触发 onClose 事件,关闭弹窗,从indexedDB中删除相应记录,并将 isSynced 设置为 true 最后,usePopup 函数返回了一个对象,包含以下属性和方法:

  • getMaxZIndex: 获取最大 z-index 的方法
  • show: 打开弹窗的方法
  • hide: 关闭弹窗的方法
  • openPopup: 打开弹窗
  • closePopup: 另一种关闭弹窗的方法
  • backLvBy: 返回到指定层级的方法
  • isSynced: 同步状态
  • id: 弹窗的唯一标识符