Skip to main content

Function: NavigationOverlay()

NavigationOverlay(options?: object): OverlayPlugin

Creates a navigation overlay plugin with prev scene, prev step, next step, next scene, and pointer toggle buttons.

Hover near the bottom to show controls with a mouse. Tap the bottom zone on touch. Swipe horizontally to navigate on touch.

Parameters​

ParameterTypeDescription
options{ triggerZone?: number; }-
options.triggerZone?numberHeight of the trigger zone at the bottom of the screen, in pixels. Defaults to 100.

Returns​

OverlayPlugin

Example​

stage.overlay(NavigationOverlay());