Docs / events
Events.
Typed, unsubscribable, synchronous handlers.
Subscribe
const off = api.on('afterLoad', ({ to, trigger }) => {
console.log('entered', to.index, 'via', trigger);
});
// later
off();Events
| event | when | payload |
|---|---|---|
beforeLeave | immediately before navigation starts | NavigationPayload |
afterLoad | destination section is active | NavigationPayload |
onSlideLeave | before a slide change | SlideNavigationPayload |
afterSlideLoad | slide change complete | SlideNavigationPayload |
afterResize | viewport dimensions changed | ResizePayload |
afterRender | initial mount complete | void |
Payload shapes
type NavigationPayload = {
from: Section;
to: Section;
direction: 'up' | 'down';
trigger: Trigger;
};
type SlideNavigationPayload = {
section: Section;
from: Slide;
to: Slide;
direction: 'left' | 'right';
trigger: Trigger;
};
type ResizePayload = {
viewport: { width: number; height: number };
};