pantoken-root / formats/scope/src / CreateScopeOptions

Interface: CreateScopeOptions ​

Beta

Options for aggregate.

Extends ​

Properties ​

theme? ​

optional theme?: string

Beta

Theme key, e.g. "rebrand". Matched by [data-pantoken-theme="…"].

Inherited from ​

ScopeConfig.theme

scheme? ​

optional scheme?: Scheme

Beta

Pinned colour scheme. Omit to follow the OS preference.

Inherited from ​

ScopeConfig.scheme

color? ​

optional color?: string

Beta

Custom brand colour key.

Inherited from ​

ScopeConfig.color

instanceId? ​

optional instanceId?: string

Beta

Identifier distinguishing this pantoken instance from others on the page. Scopes, storage keys, and frame messages are all keyed by it.

Overrides ​

ScopeConfig.instanceId

boundary? ​

optional boundary?: boolean

Beta

Stop ancestor resolution at this element, so nothing outside can theme what is inside. Use for a preview pane that must not inherit the surrounding app's theme.

persist? ​

optional persist?: boolean

Beta

Persist and restore state. Pass false to keep the scope in-memory only (default true).

storage? ​

optional storage?: Pick<Storage, "getItem" | "setItem"> | null

Beta

Storage backend (default localStorage, silently skipped when unavailable).