Events['xr:cta'] ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Property of Events · labs, @experimental · since 2.0.0

ts
'xr:cta': {
  readonly action: 'add-to-cart' | 'back' | 'other';
  readonly configuration: DeepReadonly<SceneModel> | null;
};

A call to action in AR (the in-page AR's button, the Quick Look banner): configuration is the scene model at the tap, with no key material.

Fields ​

action ​

ts
readonly action: 'add-to-cart' | 'back' | 'other';

configuration ​

ts
readonly configuration: DeepReadonly<SceneModel> | null;

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: xr:cta names no product
2. A precedent pass: model-viewer canActivateAR and activateAR() (row G66); XRSession.end() (row G66); Navigator.share() (resolves when the share UI closes) (row G66)
3. Two apps, or labs labs (@experimental at a stable path, reached through has() or supports()): it graduates when a second app uses it; apps today: configurator-template, tryon-template
4. The cheaper fix first decided per need in Appendix B: rows G66 at tier labs (a member only where no rule, data, asset or app code serves the need)