Borda Instance
The object returned by mount() — API, config, responsive, scroll, animation, skip, visibility.
The BordaInstance is returned by borda.mount() and borda.highlight(). It provides runtime access to every feature API and the reactive config store.
const instance = await borda.mount({ steps: [...] });
Properties
| Property | Type | Description |
|---|---|---|
api | BordaApi | Tour controller, components, and event bus |
config | UseBordaConfigReturns | Reactive config store |
responsive | BordaResponsiveApi | Active breakpoint info |
scroll | BordaScrollApi | Scroll-to-target API |
animation | BordaAnimationApi | Resolved animation settings |
skip | BordaSkipApi | "Don't show again" state |
visibility | BordaVisibilityApi | Show/hide API |
api
The top-level API surface:
| Property | Type | Description |
|---|---|---|
api.controller | BordaControllerApi | Tour navigation — currentStep, next, prev, changeStep, finish |
api.components | BordaComponents | References to all child component instances |
api.events | BordaEventEmitter | Pub/sub event bus for tour events |
config
The reactive config store:
// Read current config
const config = instance.config.current;
// Get a snapshot
const snapshot = instance.config.getConfig();
// Replace entirely
instance.config.setConfig({ steps: [...] });
// Deep merge
instance.config.mergeConfig({ tourButtons: { skip: false } });
Quick reference
// Tour navigation
instance.api.controller.next();
instance.api.controller.prev();
instance.api.controller.changeStep(2);
instance.api.controller.finish();
// Visibility
instance.visibility.show();
instance.visibility.hide();
// Scroll
await instance.scroll.scrollTo(document.getElementById('target'));
// Skip
instance.skip.set(true);
instance.skip.clear();
// Events
instance.api.events.on(BordaEvent.ON_TOUR_FINISH, () => { ... });
// Config
instance.config.mergeConfig({ size: ComponentSize.LG });