createRouter()

Create a uni-app router instance.

Type

function createRouter(options: RouterOptions): Router

Parameters

options

Router initialization options, type RouterOptions.

interface RouterOptions {
  routes: RouteConfig[]
  strict?: boolean
}

options.routes

Route configuration list, must be consistent with page declarations in pages.json.

options.strict

• Type: boolean
• Default: true
• Description: Whether to enable strict mode. When enabled, unmatched named routes throw ROUTE_NOT_FOUND error; when disabled, only a warning is output and the name is used as a path fallback.

Return Value

Returns a Router instance.

Example

Basic Usage

import { createRouter } from '@meng-xi/uni-router'

const router = createRouter({
  routes: [
    { path: 'pages/index/index', name: 'home', meta: { title: 'Home' } },
    { path: 'pages/about/about', name: 'about', meta: { requireAuth: true } },
    { path: 'pages/user/user', name: 'user', meta: { isTab: true } }
  ]
})

Lenient Mode

const router = createRouter({
  routes,
  strict: false
})

Register to Vue App

import { createSSRApp } from 'vue'
import App from './App.vue'
import router from './router'

export function createApp() {
  const app = createSSRApp(App)
  app.use(router)
  return { app }
}