RefreshView API Example

Using RefreshView API typically involves a chain of actions.

First, there must be a component somewhere on the page that can send a RefreshEvent event when a refresh is desired. In this example, the refreshButton component can signal a refresh.

Next, to participate in a view refresh, a component registers a handler method to be invoked after a container has received RefreshEvent. In this example, the handler method is registered in refreshHandler.js.

Finally, there must be a component somewhere on the page that registers to receive RefreshEvent. In this example, refreshContainer registers to receive refresh events. It starts a refresh process when an event is received.

Put the refreshHandler and refreshButton components in the refreshContainer template, including your namespace in the tags. c is the default namespace in this example.

See Also

• RefreshStatus Constants
• lightning/refresh module