Tour
Guides people through dynamic target elements with a focus-managed dialog and highlighted region.
Live TypeScript example
Try the component here, then use the source below in your application.
Interact with the Tour example. The code below shows its actual inputs and callbacks.
import '@bluui/web/styles.css'
import { createTour } from "@bluui/web";
export function mount(host: HTMLElement) {
const start = document.createElement("button");
start.textContent = "Start tour";
start.className = "blu-common-button blu-common-button--primary";
const target = document.createElement("button");
target.id = "project-" + crypto.randomUUID();
target.textContent = "Create project";
target.className = "blu-common-button";
host.append(start, target);
const tour = createTour(host, { Steps: [
{ Key: "create", Title: "Create your project", Description: "Choose a name and invite your team.", TargetId: target.id },
{ Key: "finish", Title: "Ready to work", Description: "Steps without a target are centered." },
] }, { Completed: () => { host.dataset.completed = "true"; } });
start.onclick = () => tour.update({ IsOpen: true, CurrentStep: 1 });
return { destroy() { tour.destroy(); start.remove(); target.remove(); } };
}
const instance = mount(document.getElementById('example')!)
// When this page or framework component is removed:
// instance.destroy()
Install the library and add the host element
npm install https://bluui.blutekmedia.com/downloads/bluui-web-0.2.6.tgz<div id="example"></div>This example uses the downloadable @bluui/web package. Your application handles persistence and authentication through its typed callbacks. The starter ZIP includes this same example.
This reference documents the published Block’s parameters, events, and types. The web examples adapt those inputs to browser callbacks. Open native showcase ↗
- Web examples
- Supported4 states checked · no automated failures
- TypeScript
- Supported2 states checked · no automated failures
- OutSystems
- Needs work2 states checked · 2 rule failures
Minimum requirement: WCAG 2.1 AA. Supported means the listed checks passed; full conformance is not yet declared.
Evidence and remaining verification →Purpose and use
Guides people through dynamic target elements with a focus-managed dialog and highlighted region.
Keyboard design guidance
Tab stays inside the step dialog. Back and Next navigate; Escape skips and restores focus. Missing targets show a centered step.
This describes the intended interaction. The dated audit above identifies verified behavior and current gaps.
In your application
Provide useful labels, preserve visible focus, and test the component with your actual content. Use text alongside status colors and check contrast in each state.
Events0No events yet.
Interact with an example to see its events.