Navigate To List (Beta)
force:navigateToList
Navigates to the list view specified by listViewId.
This event is deprecated. We recommend using the lightning:navigation component with the standard__objectPage page type instead.
For Use In
Lightning Experience, Experience Builder Sites, Salesforce Mobile App
This event enables you to navigate to the list view specified by listViewId.
We recommend using lightning:navigation component with the standard__objectPage page type instead.
For more information, see the Lightning Aura Components Developer Guide.
To navigate to a list view, set the list view ID on the listViewId attribute and fire the event. This example displays the list views for contacts.
This Apex controller returns all list views for the contact object.
You can also provide a single list view ID by providing the list view name you want to navigate to in the SOQL query.
This event is handled by the one.app container. It’s supported in Lightning Experience, the Salesforce mobile app, and Aura-based Experience Builder sites.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
listViewId | The ID of the list view to be displayed. | string |  | |
listViewName | Specifies the name for the list view and doesn't need to match the actual name. To use the actual name that's saved for the list view, set listViewName to null. | string | | |
scope | The name of the object in the view, for example, 'Account' or 'MyObject__c' | string | |