Skip to main content

Route

Reference

Parameters​

content​

This is what the router should display when the page is accessed.

Component data2-core-types@ArtboardReference

policies
list
​

Defines rules for allowing access to the route or not.

Component data2-core-auth@Policy

path​

Path in which the "content" should be accessible. It should start with a forward slash (/), and subdivisions should be done with forward slashes as well. You may receive parameters as part of the path by adding a colon (:) followed by the name of the parameter.

Example: /path/subpath/:parameter

Component data2-core-primitives@String

onEnter​

Action to be executed as soon as the user enters the route.

Component data2-core-types@Interaction

onExit​

An action to be executed as soon as the user leaves the route.

Component data2-core-types@Interaction

name​

Sets the name of the route, shown on the browser's tab.

Component data2-core-primitives@String

description​

Describe the routes details or intent here. It should display on links' previews when shared.

Component data2-core-primitives@String

icon​

Sets the icon that appears on the browser tab.

Component data2-core-types@FileComponentUrlReference

image​

Set an image do be displayed on a link preview when shared.

Component data2-core-primitives@String

priority​

Signals the importance of this page to your whole website. This value has only affects your sitemap, thus has no effect the sitemap it is disabled by your Router's configuration.

Component data2-core-primitives@String

changefreq​

Indicates how often the current page is updated. This information is passed in the sitemap when available, and has no effect if the router's Sitemap is disabled.

Component data2-core-primitives@String

One of 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'anual' | 'never'

notAllowed​

Artboard to display when the route's content has been denied access due to a policy.

Component data2-core-types@ArtboardReference