Skip to content

Route — Reference

Reference · Advanced · App Connect

Route settings and behavior. Settings include ID, Path, Url, Exact.

Route settings and events. Select the component in App Structure to find these controls in Properties.

Name Description
IDOptional unique identifier for this element. Sets the element's id attribute. Keep IDs unique per page (useful for anchors, label for targets, and JavaScript hooks). Bootstrap docs: Introduction Required. Default: "". Attribute: id.
PathEnter the path to be used. Example: <b>/some/path</b><br><br><b>Parameters</b>: <br>&nbsp;<b>Named Parameters:</b><br>&nbsp;&nbsp;Named parameters are defined by prefixing a colon to the parameter name <b>(:foo)</b>.<br>&nbsp;&nbsp;Example: <b>/path/:id</b><br><br>&nbsp;<b>Parameter Modifiers:</b><br>&nbsp;&nbsp;<b>Optional</b>: Parameters can be suffixed with a question mark (?) to <br>&nbsp;&nbsp;&nbsp;&nbsp;make the parameter optional. Example: <b>/:foo/:bar?</b><br><br>&nbsp;&nbsp;<b>Zero or more</b>: Parameters can be suffixed with an asterisk (*) to denote a zero or <br>&nbsp;&nbsp;&nbsp;&nbsp;more parameter matches. Example: <b>/:foo*</b><br><br>&nbsp;&nbsp;<b>One or more</b>: Parameters can be suffixed with a plus sign (+) to denote a one or <br>&nbsp;&nbsp;&nbsp;&nbsp;more parameter matches. Example: <b>/:foo+</b><br><br>&nbsp;&nbsp;<b>Unnamed Parameters</b>: It is possible to write an unnamed parameter that only consists of <br>&nbsp;&nbsp;&nbsp;&nbsp; a matching group. It works the same as a named parameter, except it will be <br>&nbsp;&nbsp;&nbsp;&nbsp; numerically indexed. Example: <b>/:foo/(.*)</b><br><br>&nbsp;&nbsp;<b>Custom Matching Parameters</b>: All parameters can have a custom regexp, which overrides the <br>&nbsp;&nbsp;&nbsp;&nbsp; default match of /. For example, you can match numeric id: <b>/path/:id(\d+)</b><br>&nbsp;&nbsp;&nbsp;&nbsp; or match words like either "user" or just "u": <b>/path/(user|u)</b><br> Required. Attribute: path.
UrlChoose optional content file to include when the route matches Attribute: url.
ExactMatch the route exactly, so no additional routes with same path prefix will match after it Default: false. Attribute: exact.
Name Description
ShowAction: Choose the action to execute. Output value representing the shown state. This is typically used for App Connect state binding and logic, not for styling. Bootstrap docs: JavaScript
HideAction: Choose the action to execute. Output value representing the hidden state. This is typically used for App Connect state binding and logic. Bootstrap docs: JavaScript
ErrorAction: Choose the action to execute.
UnauthorizedAction: Choose the action to execute.
ForbiddenAction: Choose the action to execute.
Not FoundAction: Choose the action to execute.