Author API Events

Fires when the app location changes, for example, when visiting an Item from the Item list, when doing a search, or when going back from an Item to the Item list.

You would want to be notified about this event firing, because you might want to take some action when the author navigates to another page, for example.

When the event has been fired, you can use event.preventDefault() to prevent the navigation to the new page.

Examples

// Standard usage to listen to the event
authorApp.on('navigate', function (event) {
    console.log('This code executes when the Author API app has navigated to a new page.');
});

// Prevent navigating to a new page
authorApp.on('navigate', function (event) {
    if (shouldNotNavigate) {
        event.preventDefault();
    }
});

Callback arguments

• location string

  The current page location, for example, activities/search.

• locationEncoded string

  The URI encoded version of current location.

• route string

  The current matching route for the app, for example, activities/search/:query

Related articles

• Building Your Own Author API User Journey Using .navigate()
• The navigate() method, which allows you to navigate to a specific page in the Author API.