Defines a PageEvent component.

Page lifecycle events are fired during various stages of navigation:

  • onCanEnter
    Runs before the view can enter. This can be used as a sort of "guard" in authenticated views where you need to check permissions before the view can enter. You must resolve(boolean) from custom action to let enter in the page.
  • onCanLeave
    Runs before the view can leave. This can be used as a sort of "guard" in authenticated views where you need to check permissions before the view can leave. You must resolve(boolean) from custom action to let leave the page.
  • onDidLoad
    Runs when the page has loaded. This event only happens once per page being created. If a page leaves but is cached, then this event will not fire again on a subsequent viewing. The onDidLoad event is good place to put your setup code for the page
  • onWillEnter
    Runs when the page is about to enter and become the active page
  • onDidEnter
    Runs when the page has fully entered and is now the active page. This event will fire, whether it was the first load or a cached page
  • onWillLeave
    Runs when the page is about to leave and no longer be the active page
  • onDidLeave
    Runs when the page has finished leaving and is no longer the active page
  • onWillUnload
    Runs when the page is about to be destroyed and have its elements removed

You can add a PageEvent component under a Page or a SharedComponent component.
Within a PageEvent component, you can add and chain any type of action such as CallSequence, CallFulSync or CustomAction component.</p>

For more information: ViewController

Name | Description --- | --- Comment | Describes the object comment to include in the documentation report.

This property generally contains an explanation about the object.

Event type | Defines the event type. Is active | Defines whether the component is active.