Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRouteEvent

The event to send when a user navigates to another page within Ultra.

An example event when navigating to base.courses.peek.course.outline:

example

 {
     eventType: 'route',
     routeData: {
         courseId: '_555_1'
     },
     routeName: 'base.courses.peek.course.outline',
     type: 'event:event',
 }

Hierarchy

  • IRouteEvent

Index

Properties

Properties

eventType

eventType: Route | RouteChanging

Will always be Route.

routeData

routeData: object

Any extra parameters on the route that the user navigated to.

Type declaration

  • [key: string]: string

routeName

routeName: string

The name of the route the user navigated to.

type

type: "event:event"

Will always be EVENT_OCCURRENCE_TYPE

Generated using TypeDoc