Skip to content

Redirect component

A redirect navigates to another location as soon as the dashboard displays the component. The component draws nothing, so it is used in a dashboard that exists only to send the user elsewhere.

Use a redirect in a dashboard that forwards the user to another page or to an external address. Do not use a redirect to provide a link that the user clicks, because the redirect cannot wait for a click. Use an Action with invoke: Navigate, or an a element in an HTML component, for a link.

Parameters

Parameter Type Required Default Description
url string Yes None Location to navigate to. A path that starts with a single / is opened inside the web interface. Any other address replaces the current page in the same browser tab

id and class are accepted but have no effect.

Example

Enter the example in the YAML tab of the dashboard editor, as described in Build a dashboard.

dashboard:
  items:
    - row:
        items:
          - redirect:
              url: /component?componentId=Battery%20Pack