Project Icon

nuxt-pwa-module

Nuxt 3的轻量级PWA解决方案

nuxt-pwa-module为Nuxt 3提供简单的PWA实现方案。该模块支持自定义Workbox服务工作器,提供usePWAIcon函数获取图标URL,并保持与Nuxt 2 PWA兼容。虽然项目已停止维护,但仍为Nuxt 3开发者提供了便捷的PWA功能。建议考虑使用Vite PWA作为替代方案。

⚠️ 已弃用 ⚠️

Nuxt 3Vite驱动,后者现在有一个很棒的PWA插件,并支持Nuxt。

由于出现了更好的解决方案,因此本模块将不再维护。

请考虑使用Nuxt 3的Vite PWAVite PWA Assets Generator作为替代。

作为主要维护者(@kevinmarrec),我要感谢所有贡献者和信任这个项目的用户🙏。

Nuxt 3 PWA

npm版本 npm下载量 Github Actions Codecov

Nuxt 3的零配置PWA解决方案

图片

官方模块的状态

此模块是非官方的,但旨在成为官方Nuxt PWA模块的下一个迭代版本。

设置

@kevinmarrec/nuxt-pwa依赖添加到您的项目中:

# 使用Yarn
yarn add -D @kevinmarrec/nuxt-pwa
# 使用NPM
npm install -D @kevinmarrec/nuxt-pwa
# 使用PNPM
pnpm install -D @kevinmarrec/nuxt-pwa

编辑您的nuxt.config.ts文件以添加PWA模块:

export default defineNuxtConfig({
  modules: [
    '@kevinmarrec/nuxt-pwa'
  ]
})

配置

由于此模块尝试与Nuxt 2 PWA兼容以便于迁移,您仍然可以使用https://pwa.nuxtjs.org文档来了解大多数功能。

如果您希望您的应用在开发环境中可安装,您需要在nuxt.config中将pwa.workbox.enabled选项设置为true,因为默认情况下它只在生产环境中启用:

export default defineNuxtConfig({
  modules: [
    '@kevinmarrec/nuxt-pwa'
  ],
  pwa: {
    workbox: {
      enabled: true
    }
  }
})

如果您需要自定义workbox服务工作器,可以使用pwa.workbox.templatePath选项指定工作器的路径,您可以使用路径别名,如~@

export default defineNuxtConfig({
  modules: [
    '@kevinmarrec/nuxt-pwa'
  ],
  pwa: {
    workbox: {
      templatePath: '~/path/to/your/worker.js'
    }
  }
})

要自定义它,您可以查看此模块的默认设置在这里,以及Nuxt 2的默认设置Workbox文档

组合式函数

usePWAIcon (size, options)

您可以使用usePWAIcon获取PWA的图标URL,并在您的应用中使用它。

const icon = usePWAIcon(512) // /assets/icons/512x512.png
const icon = usePWAIcon(512, { maskable: true }) // /assets/icons/512x512.maskable.png

或者,您可以使用string而不是number作为size参数,以利用TypeScript中可用的尺寸:

图片

开发

确保安装依赖:

pnpm install

http://localhost:3000上启动开发服务器:

pnpm dev

示例

http://localhost:3000上构建并启动示例:

pnpm example:build
pnpm example:start

许可证

用❤️制作

根据MIT许可证发布。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号