Skip to content

框架接入

请根据应用使用的路由方案选择对应适配器。

Vite 与 Vue Router

ts
import PageFlow from 'unplugin-pageflow'

export default defineConfig({
  plugins: [PageFlow.vite()],
})

Nuxt

ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['unplugin-pageflow/nuxt'],
})

Astro

ts
// astro.config.mjs
import PageFlow from 'unplugin-pageflow/astro'
import { defineConfig } from 'astro/config'

export default defineConfig({ integrations: [PageFlow()] })

Astro 适配器会发现文件路由、同源链接和显式声明的 data-pageflow-to 目标,但不会检查框架岛内部的实现。

React Router

ts
import PageFlow from 'unplugin-pageflow/react-router'

export default defineConfig({
  plugins: [react(), PageFlow(routeObjects)],
})

SvelteKit

ts
import PageFlow from 'unplugin-pageflow/sveltekit'

export default defineConfig({
  plugins: [sveltekit(), ...PageFlow()],
})

SolidStart

ts
import PageFlow from 'unplugin-pageflow/solid-start'

export default defineConfig({
  plugins: [...PageFlow(), solid()],
})

Qwik City

ts
import PageFlow from 'unplugin-pageflow/qwik-city'

export default defineConfig({
  plugins: [qwikCity(), qwikVite(), PageFlow()],
})

Next.js

Next.js 使用一个仅在开发环境运行的同源 sidecar:

bash
pageflow-next --dir . --host 127.0.0.1 --port 3000

生产构建不会使用该 sidecar。

uni-app

PageFlow 支持当前基于 Vite 的 uni-app 项目,并在开发时读取其生成的路由。

基于 MIT 许可证发布。