Events

history.willChange

Detailed viewer event reference for history.willChange.

Summary

  • Category: History
  • Event: history.willChange
  • Trigger: Fires before history stack state changes.

Payload

[HistoryChangeEvent];

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('history.willChange', payload);
}

instance.addEventListener('history.willChange', onEvent);
instance.removeEventListener('history.willChange', onEvent);