vite-uni-route
v0.0.5
Published
在Vite构建的Vue应用中,编译阶段扫描pages.json,更新pages.json,添加路由name、路由type,useRouter在插件运行的时候
Downloads
9
Maintainers
Readme
vite-uni-route
vite-uni-route 是一个专为 UNIAPP 设计的 Vite 插件,为 Vue 3 + Vite 构建的项目提供支持。它允许在编译阶段,对pages.json进行扫描,并且生成相应的name标识。搭配utils中useRouter()方法,即可实现路由跳转。
安装
要在您的项目中安装 vite-uni-route 插件,可以使用以下命令:
pnpm install vite-uni-route
或者,如果您使用 npm:
npm install vite-uni-route
或者,如果您使用 yarn
yarn install vite-uni-route
使用方法
- 在
uni()
方法之前引入 - 无需其他配置
import { defineConfig } from 'vite';
import uni from '@dcloudio/vite-plugin-uni';
import {uniRouteImport} from 'vite-uni-route';
export default defineConfig(() => {
return {
plugins: [uniRouteImport(), uni()],
};
});
useRouter 参数配置
- useRouter 入参支持
路由name:string
以及object
- 并且支持ts提示
string
- 类型:
Path
- 默认值:
undefined
- Path类型为插件运行时自动生成,并且这useRouter方法中自动引入
object
- 类型:
RouterParams
| 参数名 | 类型 | 描述 | 默认值 | 是否可选 |
| ------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------- | -------- |
| path | Path
| 单页面路由文件名。自动生成 | | 必选 |
| params | Record<string, any>
| 路由传递的参数对象。 | undefined
| 可选 |
| close | 'default' 'current' 'all'
| 'default'
: 不关闭任何页面直接跳转。'current'
: 关闭当前页后跳转。'all'
: 关闭所有页面后跳转。 | default
| 可选 |