Skip to content

Add Type generic for RouteRecordRaw Meta data #833

@bastiW

Description

@bastiW

What problem does this feature solve?

My route metadata should be type save

What does the proposed API look like?

Add a generic to RouteRecordRaw type.

The API in short

const routes:  RouteRecordRaw<RouteMeta>[]  = // Routes are here

Full example:

import {createRouter, createWebHashHistory, RouteRecordRaw} from 'vue-router'

export type RouteMeta = {
  label: string,
  iconClass: string,
}


const routes:  RouteRecordRaw<RouteMeta>[] = [
  {
    path: '/',
    name: 'Home',
    component: Home,
    meta: {
      label: 'My Home',
      iconClass: 'home-icon',
    },
  },
  {
    path: '/settings',
    name: 'Settings',
    component: Settings,
    meta: {
      label: 'Settings',
      iconClass: 'settings-icon',
    }
  },
]

const router = createRouter({
  history: createWebHashHistory(),
  routes
})

export default router

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions