The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.


createRouter() takes a RouterConfig object. RouterConfig has to contain an array of RouteDefinition objects.

idStringRequiredEach RouteDefinition has to have a unique identifier.
uriStringA string pattern for URI locations that match this RouteDefinition. You can use the following characters: /, :parameter, ?, &. You can't use # or *.
pageThe form of page references that match the LwrConfigRouteDefinition. page values can be :parameter bindings, which map a path or query parameter from the URI to an attributes or state property, or literal bindings, which hard code a type, attribute, or state property to a literal value. Literal bindings can't contain the following characters: ?, *, #, &, +, ;, (, ).
handlerStringOptionalA promise to a module that's called when a RouteDefinition matches a location. For more information, see Route Definition Handlers.
patternsOptionalA regular expression that a parameter has to match to be valid. To prevent unexpected values in the expression pattern, explicitly wrap the expression in the start-of-line character (^) and end-of-line character ($). For example: {"patterns": {"parameter": "^id[0-9a-zA-Z]{5}$"}}.
exactBooleanOptionalIf there's a nested router, this value must be false. The default value is true.
metadataOptionalDeveloper-defined metadata in the form of key (string) and value (any type) pairs. You can use the metadata property to attach additional information to an LwrConfigRouteDefinition. Extend LwrConfigRouteDefinition for required or more strongly typed metadata.

See Also