Interface: EditGateOptions
Defined in: gate.ts:42
@realitycollective/uix-devtools - client-side entry.
Only the pieces safe to reference from app code are exported here: the edit-session gate (designed to be compiled out of production builds) and the runtime UIKitML compiler that powers live panel editing.
The uix-dev CLI ships from the same package (bin/uix-dev.mjs,
@realitycollective/uix-devtools/cli) but is node-only - never import it
from client code.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
href? | string | Page URL to inspect. Default: window.location.href. | gate.ts:59 |
load | (session: EditSession) => void | Promise<unknown> | Loader called exactly once when the gate opens. Do the dynamic import of your dev overlay here so it stays in its own chunk: load: (session) => import('./dev-overlay.js').then(m => m.install(session)) | gate.ts:48 |
param? | string | URL query parameter name. Default: DEFAULT_EDIT_PARAM. | gate.ts:57 |
remember? | boolean | Remember an accepted token in sessionStorage so reloads (e.g. re-entering VR) keep the session without the query param. Default: true. | gate.ts:64 |
storage? | TokenStorage | Storage override for tests. Default: window.sessionStorage. | gate.ts:66 |
tokens? | readonly string[] | Tokens that are allowed to open the gate. Typically [import.meta.env.VITE_UIX_EDIT_TOKEN] - minted per run by uix-dev. When omitted or empty, ANY non-empty token opens the gate; only do that in local dev builds that never leave your machine. | gate.ts:55 |