Skip to main content

Navigation

Overview​

The Navigation component provides the ability to navigate the user to record pages, related lists, objects tab, and more.

Global Configuration Inputs​

These inputs apply to all Navigation types.

Type​

The type of navigation to perform.

  • url: A full or relative url.
  • record: An individual record
  • object: The object list view tab.
  • related list: The related list of a specific record.
  • tab: Visualforce tabs, web tabs, Lightning Pages, or Lightning Component tabs
TypeValid ValuesRequired
Texturl, record, object, related list, tabYes

Replace Browser History​

This is an advanced input that is only used in special use cases.

If set to true, the page replaces the existing entry in the browser history so the user doesn’t have to press the back button twice.

An example of this would be a user on the Home page of Lightning app. The user clicks a different tab that hosts a Flow for the simple act of performing a redirect based upon some condition defined in the flow. If set to true, the user is redirected back to the Home page instead of the redirect page.

Type
Boolean

URL Navigation Inputs​

URL​

The URL to navigate to.

TypeRequired
TextYes

Open In New Window​

If set to true, the URL will open in a new window or browser tab. This value defaults to false.

TypeRequired
BooleanNo

Record Navigation Inputs​

Object API Name​

The the api name of the object to navigate to.

TypeRequired
TextYes

Record ID​

The ID of the record to navigate to.

TypeRequired
TextYes

Action​

The record page to navigate to.

TypeValid ValuesRequired
Textclone, edit, viewYes

Object Navigation Inputs​

Object API Name​

The the api name of the object to navigate to.

TypeRequired
TextYes

Action​

The record page to navigate to.

TypeValid ValuesRequired
Texthome, list, newYes

List View​

The ID or name of the list view to load when action is set to list.

Type
Text

Object API Name​

The the api name of the object to navigate to.

TypeRequired
TextYes

Record ID​

The ID of the record to navigate to.

TypeRequired
TextYes

Relationship Name​

The api name of the relationship name for the related list.

TypeRequired
TextYes

Tab Navigation Inputs​

Tab Name​

The api name of the tab to navigate to.

TypeRequired
TextYes