API Documentation / RouteLocationMatched

Interface: RouteLocationMatched

Normalized version of a route record.

Hierarchy

• RouteRecordNormalized

  ↳ RouteLocationMatched

Properties

aliasOf

• aliasOf: undefined | RouteRecordNormalized

Defines if this record is the alias of another one. This property is undefined if the record is the original one.

Inherited from

RouteRecordNormalized.aliasOf

---

beforeEnter

• beforeEnter: undefined | NavigationGuardWithThis<undefined> | NavigationGuardWithThis<undefined>[]

Registered beforeEnter guards

Inherited from

RouteRecordNormalized.beforeEnter

---

children

• children: RouteRecordRaw[]

Nested route records.

Inherited from

RouteRecordNormalized.children

---

components

• components: undefined | null | Record<string, RouteComponent>

Components to display when the URL matches this route. Allow using named views.

Overrides

RouteRecordNormalized.components

---

enterCallbacks

• enterCallbacks: Record<string, NavigationGuardNextCallback[]>

Registered beforeRouteEnter callbacks passed to next or returned in guards

Inherited from

RouteRecordNormalized.enterCallbacks

---

instances

• instances: Record<string, undefined | null | ComponentPublicInstance>

Mounted route component instances Having the instances on the record mean beforeRouteUpdate and beforeRouteLeave guards can only be invoked with the latest mounted app instance if there are multiple application instances rendering the same view, basically duplicating the content on the page, which shouldn't happen in practice. It will work if multiple apps are rendering different named views.

Inherited from

RouteRecordNormalized.instances

---

leaveGuards

• leaveGuards: Set<NavigationGuard>

Registered leave guards

Inherited from

RouteRecordNormalized.leaveGuards

---

meta

• meta: RouteMeta

Arbitrary data attached to the record.

Inherited from

RouteRecordNormalized.meta

---

name

• name: RouteRecordNameGeneric

Name for the route record. Must be unique.

Inherited from

RouteRecordNormalized.name

---

path

• path: string

Path of the record. Should start with / unless the record is the child of another record.

Inherited from

RouteRecordNormalized.path

---

props

• props: Record<string, _RouteRecordProps>

Allow passing down params as props to the component rendered by router-view. Should be an object with the same keys as components or a boolean to be applied to every component.

Inherited from

RouteRecordNormalized.props

---

redirect

• redirect: undefined | RouteRecordRedirectOption

Where to redirect if the route is directly matched. The redirection happens before any navigation guard and triggers a new navigation with the new target location.

Inherited from

RouteRecordNormalized.redirect

---

updateGuards

• updateGuards: Set<NavigationGuard>

Registered update guards

Inherited from

RouteRecordNormalized.updateGuards