StateRule | @uirouter/core
Options
Menu

Interface StateRule

Hierarchy

Index

Properties

$id: number

The rule's ID.

The rule's ID.

IDs are auto-assigned when the rule is registered, in increasing order.

handler: UrlRuleHandlerFn

This function is called if the rule matched, and was selected as the "best match". This function handles the rule match event.

This function is called if the rule matched, and was selected as the "best match". This function handles the rule match event.

See UrlRuleHandlerFn for details

match: UrlRuleMatchFn

This function should match the url and return the match details

This function should match the url and return the match details

See UrlRuleMatchFn for details

priority: number

The rule's priority (defaults to 0).

The rule's priority (defaults to 0).

This can be used to explicitly modify the rule's priority. Higher numbers are higher priority.

type: "STATE"
urlMatcher: UrlMatcher

Methods

  • matchPriority(match: any): number
  • The priority of a given match.

  • The priority of a given match.

    Sometimes more than one UrlRule might have matched. This method is used to choose the best match.

    If multiple rules matched, each rule's matchPriority is called with the value from match. The rule with the highest matchPriority has its handler called.

    Parameters

    • match any

    Returns number


Generated using TypeDoc