Skip to content
HomePagesHomePages template kit
Menu
Start here
What you're buildingInstallFirst renderRead the starterAdd a slotShip it
Concepts
The pipelineSections and declarationsSlotsFacts and provenanceAI fillFixtures and scenariosValues and emptinessThe marker contractServer and clientTheme modelFrames and formatsComposition and reconcileVersioningStaying current
Guides
API reference
Rules

tourEmbedUrl

The embeddable player URL for a pasted 3D-tour link, or `null` when the value is empty, names no provider, names one that is not a tour provider, or is a tour URL the provider's embed form cannot be built from.

The embeddable player URL for a pasted 3D-tour link, or null when the value is empty, names no provider, names one that is not a tour provider, or is a tour URL the provider’s embed form cannot be built from.

Import from @homepages/template-kit.

Signature

Section titled “Signature”
function tourEmbedUrl(raw: string): string | null

Parameters

Section titled “Parameters”
Name Type Required Description
raw string required

Returns

Section titled “Returns”

string | null

Constraints

Section titled “Constraints”
  • Covers every kind: "tour" member of LINK_PROVIDERS. A tour provider added to that catalog without a branch here returns null — an unembeddable slot rather than a wrong iframe — and slot-catalog.test.ts fails on the gap.

See also

Section titled “See also”