tour
A single 3D-tour slot, resolved as a `TourValue`.
A single 3D-tour slot, resolved as a TourValue. Its own kind rather than a
third video source: playback is meaningless on a walkthrough, and the fill
pool would otherwise mix videos with tour models. frame is the only
type-specific option — there is no crop (a tour is selected, never edited),
no playback, no sources and no accepts; which providers are admitted
widens in the link-provider catalog, never on a slot.
Render it with <Slot.Tour> for the embed, <Slot.Image> for the tour’s
thumbnail, or both — two positions from one selection.
fill takes a tourAssign — the alternative to source, never its companion.
Import from @homepages/template-kit.
Signature
Section titled “Signature”function tour<const HasSource extends SlotSource | ComputeBinding<unknown> | undefined = undefined>(opts: TourOptions & { source?: HasSource; fill?: BuiltDecision<"tour-assign">; } & WritebackOption<HasSource> & FillOption<HasSource, BuiltDecision<"tour-assign">>): TourSlotDef & SourceMark<HasSource> & FillMark<BuiltDecision<"tour-assign">>Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
opts |
`TourOptions & { source?: HasSource; fill?: BuiltDecision<“tour-assign”> } & |
WritebackOption<HasSource> & FillOption<HasSource, BuiltDecision<"tour-assign">>` | required | |Returns
Section titled “Returns”TourSlotDef & SourceMark<HasSource> & FillMark<BuiltDecision<"tour-assign">>
Example
Section titled “Example”import { tour, tourAssign } from "@homepages/template-kit";
tour({ label: "3D tour", fill: tourAssign({ pick: "The whole-home walkthrough." }) });