Vue: the Omnibar's guided walk is a single-file component

OmnibarGuide renders the walk's spotlight ring and callout, teleported to the
end of the body as before, with the kit's UiCloseButton for its close and
UiButtons for Not now, the offer and Next. startGuide() keeps its signature
and every decision and word: it renders the view synchronously from what it
computes for each step and keeps the parts the template never binds: the
guide's visible class and the callout's entrance replay (in the same order,
so the first step still fades in), the callout's place and side and the
rings' boxes each frame, focus and its return, Escape and the checks for a
screen another surface owns.

The ids, roles, aria attributes, hidden attributes, tabindex, text and focus
order are unchanged. The buttons gain the kit's classes, which carry no
rules, so they look as before. The close drops the aria-hidden span around
its glyph: its name is still its aria-label, "End guide", and its tip the
same words. Progress segments are new elements each step, as before, so a
segment's colour does not animate across steps, and the status line changes
once per step.

New tests: the walk is the last of the body, takes focus and gives it back,
announces each step once and draws new progress each step, and a new walk
ends the one in progress.

Co-authored-by: Manjunath Paparaju <[email protected]>
This commit is contained in:
Sameh KhamisandManjunath Paparaju committed 2026-11-19 02:10:49 -08:00
1 parent 7c858d96ee
commit 10a26e15ce
7 files changed
+293 -80

No files matched your search

+89
View File
@@ -0,0 +1,89 @@
<script setup>
import { ref } from 'vue';
import UiButton from '../../kit/UiButton.vue';
import UiCloseButton from '../../kit/UiCloseButton.vue';
// The Omnibar's guided walk: the spotlight ring and the callout beside it,
// teleported to the end of `to` (the page's body). `startGuide()` in
// src/ui/omnibarGuide.js owns every decision and every word: it renders this
// with the `view` it computes for each step and keeps the parts the template
// never binds: the guide's `visible` class, the callout's entrance replay
// (its `swap` class), place and side, the ring's and the extra rings' boxes,
// and focus. The elements those parts need are exposed.
defineProps({
to: { type: Object, required: true },
view: { type: Object, required: true },
onClose: { type: Function, required: true },
onSkip: { type: Function, required: true },
onOffer: { type: Function, required: true },
onNext: { type: Function, required: true },
});
const root = ref(null);
const ring = ref(null);
const callout = ref(null);
defineExpose({ root, ring, callout });
/** A progress segment's attributes: no class at all for one still to come. */
const dot = (name) => (name ? { class: name } : {});
</script>
<!-- Only line breaks inside tags: the markup has no whitespace between elements. -->
<template><Teleport :to="to"
><div ref="root" class="gev-guide"
><div ref="ring" class="gev-guide-ring"><i></i></div
><div
ref="callout"
class="gev-guide-callout"
role="dialog"
aria-modal="false"
tabindex="-1"
aria-labelledby="gev-guide-title"
aria-describedby="gev-guide-text"
><div class="gev-guide-head"
><p id="gev-guide-title" class="gev-guide-title">{{ view.title }}</p
><p class="gev-guide-count">{{ view.count }}</p
><UiCloseButton
class="gev-guide-close"
:label="view.endLabel"
:title="view.endLabel"
@click="onClose()" /></div
><ol class="gev-guide-progress" aria-hidden="true"
><li
v-for="(name, i) in view.progress"
:key="`${view.step}-${i}`"
v-bind="dot(name)"></li></ol
><div class="gev-guide-body"
><p id="gev-guide-text" class="gev-guide-text">{{ view.text }}</p
><p class="gev-guide-hint" :hidden="view.hintHidden"
><span class="gev-guide-hint-dot"></span
><span>{{ view.hint }}</span></p
></div
><div class="gev-guide-actions"
><p class="gev-guide-keys" :hidden="view.keysHidden"
><kbd>{{ view.keyCap }}</kbd><span>{{ view.keyText }}</span></p
><span
><UiButton
class="gev-guide-skip"
:hidden="view.skipHidden"
@click="onSkip()"
>{{ view.skipLabel }}</UiButton
><UiButton
class="gev-guide-offer"
:hidden="view.offerHidden"
@click="onOffer()"
>{{ view.offerLabel }}</UiButton
><UiButton
class="gev-guide-next"
:class="{ quiet: view.nextQuiet }"
:hidden="view.nextHidden"
@click="onNext()"
>{{ view.nextLabel }}</UiButton
></span
></div
><p class="gev-guide-status" role="status" aria-live="polite">{{
view.status
}}</p></div
></div
></Teleport
></template>