pantoken-root / formats/scope/src / PantokenScope

Schnittstelle: PantokenScope ​

Beta

Ein lebender Bereich, der an ein Element gebunden ist.

Eigenschaften ​

element ​

readonly element: HTMLElement

Beta

Das Element, das die Bereichsattribute trägt.

instanceId ​

readonly instanceId: string

Beta

Das Produkt, zu dem das Logo gehört.

Methoden ​

get() ​

get(): ScopeConfig

Beta

Die eigene Konfiguration des Bereichs — was er deklariert, nicht was er erbt.

Rückgabe ​

ScopeConfig

set() ​

set(patch): void

Beta

Eine partielle Konfiguration zusammenführen. Übergebe null für ein Feld, um es zu löschen und wieder zu erben.

Parameter ​

patch ​

Partial<Record<keyof ScopeConfig, string | null | undefined>>

Rückgabe ​

void

resolve() ​

resolve(el?): ResolvedScope

Beta

Bestimme den wirksamen Bereich für ein Nachkommelement (Standard ist das eigene Element dieses Bereichs).

Parameter ​

el? ​

Element

Rückgabe ​

ResolvedScope

attachFrame() ​

attachFrame(frame): () => void

Beta

Sende den Zustand dieses Bereichs an frame und halte ihn synchron. Gibt eine Funktion zum Trennen zurück.

Parameter ​

frame ​

HTMLIFrameElement

Rückgabe ​

() => void

subscribe() ​

subscribe(listener): () => void

Beta

Beobachte Änderungen. Gibt eine Abmeldefunktion zurück.

Parameter ​

listener ​

(config) => void

Rückgabe ​

() => void

destroy() ​

destroy(): void

Beta

Entfernt die Attribute, trennt Frames und meldet ab.

Rückgabe ​

void