【unibest文档】三、插件篇

大家好,我是 菲鸽,今天带给大家 unibest 文档系列文章第3篇 ------ 插件篇。欢迎食用~

unibest - 官方文档地址:codercup.github.io/unibest-doc...

引言

有群友第一次看到 unibest 里面 vue 文件 route-block 这种写法,表示很奇怪,啥时候支持这种写法了,没学过啊,穿越了?!

html 复制代码
<route lang="json5">
{
  layout: 'demo',
  style: { navigationBarTitleText: 'UniUI 使用' },
}
</route>

<template>
  <uni-card>
    <text>这是一个基础卡片示例,内容较少,此示例展示了一个没有任何属性不带阴影的卡片。</text>
  </uni-card>
</template>

哈哈,这个当然是 uni插件 的功劳了,具体点是 @uni-helper/vite-plugin-uni-pages 插件的功劳,该插件由 uni-helper 官方团队开发。

本文就来说说 unibest 都引入了哪些有用的 Vite插件,主要分为2大类,一类是 uni插件,另外一类是 通用插件。下面这个表格描述了各个插件的主要作用。

插件名 作用
@dcloudio/vite-plugin-uni 最核心的 uni 插件 ,没有它就不能在 vite 项目跑 uniapp,其他所有的 uni插件 都需要经通过它的手来编译,所以写法上,都是先写 UniXXX,再写 Uni,见下文
@uni-helper/vite-plugin-uni-pages uni 插件,也是 unibest 灵魂插件,route-block 就是它的功劳,让你可以直接在本文件就能设置页面的路元信息,无需跑去 pages.json 配置,同时支持 pages.config.ts 编写 pages.json
@uni-helper/vite-plugin-uni-layouts uni 插件,支多种 layouts 布局,群友脑洞大开,充分利用这个特性实现平时不容实现的写法
@uni-helper/vite-plugin-uni-manifest uni 插件,支持 manifest.config.ts 编写 manifest.json
unocss/vite 通用插件,Unocss 插件
vite-svg-loader 通用插件,自动导入 svg
unplugin-auto-import/vite 通用插件,自动导入 API
rollup-plugin-visualizer 通用插件,build 后生成可视化打包图,方便优化包
vite-plugin-restart 通用插件,vite 配置更改后自动重启服务

UniXXX() 插件都需要在 uni() 之前引入,因为最终都需要 Uni 来处理所有的代码。如下图:

接下来介绍一下 uni 插件,其他 通用插件 大家都比较熟悉,不再赘述。

uni插件总览

unibest 引入了 uni-helper 团队的几个重要插件,少了它们 unibest 就缺少了灵魂,感谢 uni-helper 团队的贡献。Uni 插件 列表如下:

vite-plugin-uni-pages

得益于 @uni-helper/vite-plugin-uni-pages,约定式路由(文件路由)的实现轻而易举。

src/pages 目录下的每个文件都代表着一个路由。要创建新页面,只需要在这个目录里新增 .vue 文件,插件会自动生成对应的 pages.json 文件。

route 代码块则可以配置页面相关信息,这些信息会自动同步到 page.json,无需切换到 page.json 进行配置。

pages.json 文件是自动生成的,请不要手动修改,全局的东西请在 pages.config.ts 里面配置,页面上的东西请在 vue 文件的 route 代码块配置,如下图。

vue 复制代码
<!-- 使用 type="home" 属性设置首页,其他页面不需要设置,默认为page -->
<!-- 推荐使用json5,更强大,且允许注释 -->
<route lang="json5" type="home">
{
  style: {
    navigationStyle: 'custom',
    navigationBarTitleText: '首页',
  },
}
</route>
<template>
  <div>
    <h1>欢迎使用 unibest</h1>
    <h4>unibest 是最好的 uniapp 开发模板</h4>
  </div>
</template>
vue 复制代码
<route lang="json5">
{
  style: {
    navigationBarTitleText: '关于',
  },
}
</route>
<template>
  <view>
    <view>通过 `/pages/about` 来访问这个页面</view>
  </view>
</template>

设置首页

通过在 route-block 里面配置 type="home" 即可,尽量保证一个项目 只有一个 这个配置,如果有多个,会按照字母顺序来排列,最终可能不是您想要的效果。

设置 pages 过滤和分包

  • 过滤:默认 src/pages 里面的 vue 文件都会生成一个页面,如果不需要生成页面可以对 vite.config.ts 中的 UniPages 进行 exclude 配置。

  • 分包:如果需要设置 分包 则可以通过 subPackages 进行配置,该配置项是个数组,可以配置多个 分包,注意分包的目录不能为 src/pages 里面的子目录。

ts 复制代码
UniPages({
  exclude: ['**/components/**/**.*'],
  subPackages: ['src/pages-sub'], // 是个数组,可以配置多个,但不能为 `src/pages` 里面的子目录
})

vite-plugin-uni-layouts

得益于 @uni-helper/vite-plugin-uni-layouts,你可以轻松地切换不同的布局。

src/layouts 文件夹下的 vue 文件都会自动生成一个布局,默认的布局文件名为 default ,路径 src/layouts/default.vue 。

如果需要修改使用的布局,可以通过 vue 文件内 route 代码块指定需要的布局,如下示例使用 demo 布局。

vue 复制代码
<route lang="json5">
{
  layout: 'demo',
  style: {
    navigationBarTitleText: '关于',
  },
}
</route>
vue 复制代码
<template>
  <view>
    <!-- 这里可以写通用的布局,比如导航栏,tabbar等 -->
    <!-- slot里面装的就是子页面的内容 -->
    <slot />
  </view>
</template>

vite-plugin-uni-manifest

得益于 @uni-helper/vite-plugin-uni-manifest,你可以使用 TypeScript 来编写 manifest.json。

manifest.json 文件是自动生成的,请不要手动修改,需要配置的内容请在 manifest.config.ts 里面配置。

总结

本文介绍了 unibest 引入的主要插件,分为 uni插件 和 通用插件,并重点详细介绍了 uni插件。

如果还想了解更多信息,可以去 uni-helper 官方仓库看看。

全文完~

相关推荐
wuxianda10302 天前
uniapp 与跨端打包项目:壳子和框架层默认特征,相似是从哪里来的
uni-app
码间留白2 天前
uni-app 鸿蒙端提现点不动?我用 UTS 插件补上了微信"确认收款"
uni-app·harmonyos·鸿蒙·uts插件·微信商家转账
wuxianda10302 天前
苹果 App 上架 4.3(a) 问题解决方案(适用 uniapp、Objective-C、Swift、Flutter 等项目)
uni-app·objective-c·swift
码间留白3 天前
AI 给的两个方案都被我否了:把 startIcon 与启动遮罩做成同一张图,鸿蒙 APP 冷启动零白屏
性能优化·uni-app·ai编程·harmonyos
anyup3 天前
自带 uni-app x 页面级能力,uView Pro X 8 个开箱即用的工具函数
前端·vue.js·uni-app
码间留白9 天前
六轮真机实验后,我把鸿蒙直播推流的 UI 全逼成了原生——uni-app 适配 HarmonyOS NEXT 完整复盘
uni-app·鸿蒙·harmonyos next·直播推流·arkts/arkui
wuxianda103010 天前
2026 苹果审核 4.3 (a) 被拒全解析|Guideline 4.3a spam 马甲包拒审原因 + 避坑方案
flutter·uni-app·苹果上架
头发还在的女程序员12 天前
基于 Spring Boot + Vue 3 + uni-app 的灵活用工系统:四端架构与业务流程设计
vue.js·spring boot·uni-app·灵活用工·灵工系统
Dumbness13 天前
订阅消息弹窗必须在用户点击里调:联调实验室里 timing 和 Mock 支付通知踩的坑
javascript·uni-app
码间留白15 天前
uni-app 鸿蒙离线打包:一个改动从源码到真机要穿过几条链
uni-app·鸿蒙·deveco·离线打包·uts插件