Skip to content

PageManager.submitStarted

PageManager.submitStarted is an event on the Event Bus that occurs whenever a Turbo.submit-start event is fired in a page. To read more about Turbo visit the Page Manager Api documentation

Event body

Visit a Turbo.submit-start event documentation page to get the information about the data available as the event body.

Example

In this example we listen to PageManager.submitStarted event and perform an action whenever it's emitted.

useStorefront(async (storefront) => {
    storefront.eventBus.on('PageManager.submitStarted', () => {
        console.log('The submit action has started');
    });
});

Example

In this example we use a Message Storage API to retrieve an array of past PageManager.submitStarted events.

useStorefront((storefront) => {
    const messageStorageApi = storefront.getApiSync('messageStorageSystemApi');

    const pastSubmitStartedEvents = messageStorageApi.getChannelMessages('PageManager.submitStarted');

    if (pastSubmitStartedEvents.length > 0) {
        pastSubmitStartedEvents.forEach(({ body: eventBody }) => {
            console.log('perform action on every past event');
        });
    }
});

JS API reference