pantoken / renderers/tinymce/src / CssDocEntry

Schnittstelle: CssDocEntry ​

Ein dokumentierter CSS-Eintrag: seine Basisklasse plus alles, was aus dem CSS + Doc-Kommentaren abgeleitet ist.

Eigenschaften ​

name ​

name: string

Der Eintragsname aus @component/@utility/@rule/@declaration/@name, z. B. button.

kind ​

kind: CssRecordKind

Welche Art von CSS-Oberfläche dies dokumentiert (Standard: component).

className ​

className: string

Der Basis-CSS-Selektor — eine Klasse (.button), ein Attribut ([data-layout="x"]), eine ID (#foo), oder ein Shadow-DOM-Pseudo (:host) — abgeleitet aus der ersten nackten Klassenregel oder explizit gesetzt via @selector. Immer nicht leer (fällt auf .${name} zurück, wenn die Ableitung fehlschlägt).

summary? ​

optional summary?: string

Einzeilige Zusammenfassung aus @summary.

remarks? ​

optional remarks?: string

Ausführlicher Text aus @remarks.

privateRemarks? ​

optional privateRemarks?: string

Nur-interner Text aus @privateRemarks (Emitter können ihn aus der öffentlichen Ausgabe weglassen).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Die Veröffentlichungsphase aus einem Modifier-Flag-Tag (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Eingeführte Version, aus @since.

group? ​

optional group?: string

Eine Dokumentationsgruppe/Kategorie, aus @group/@category.

accessibility? ​

optional accessibility?: string

Barrierefreiheitsleitfaden, aus @a11y/@accessibility.

global? ​

optional global?: boolean

Gesetzt, wenn dieser Eintrag ein @global-Tag trägt — seine Modifier (und pro-Modifier @global-Flags) gelten für jede Komponente/Layout/Regel/Deklaration, nicht nur für die Basisklasse dieses Eintrags. Wird bei Validierungs- und Verbrauchschecks verwendet, um Modifier-Übereinstimmungen global aufzulösen.

modifiers ​

modifiers: CssModifier[]

Vom AST extrahierte Modifier, mit @modifier-Text versehen, wo sie verfasst wurden.

parts ​

parts: CssPart[]

Vom AST extrahierte Sub-Element-Teile (klassenbasiert), mit @part-Text versehen, wo sie verfasst wurden.

shadowParts ​

shadowParts: CssPart[]

Für Shadow-DOM exponierte Parts (::part(name)), aus @csspart oder einem ::part()-Selektor.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native Pseudo-Elemente, auf die die Komponente abzielt (::before, ::marker, …), aus @pseudo oder einem Selektor.

states ​

states: CssState[]

Zustände, auf die die Komponente reagiert, aus @cssstate, :state(), Pseudo-Klassen oder Zustandsklassen.

slots ​

slots: CssSlot[]

Benannte Slots, die die Komponentenschale aussetzt, aus @slot.

elements? ​

optional elements?: CssElementConstraints

Erlaubte HTML-Elemente aus @element (Standard + optionale benannte Profile).

todos ​

todos: string[]

Interne To-do-Notizen, aus @todo-Tags und /* @todo … */ Inline-Kommentaren. Entwicklungshinweise, keine öffentliche API — Emitter können sie weglassen (wie CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design-Tokens, die diese Komponente nutzt: jede --* Custom Property, die via var(...) in seinen Regeln referenziert wird, jede mit @tokens-Text versehen, wo sie verfasst wurde (und inklusive jedes via @tokens deklarierten Tokens, das nicht wörtlich via var() gefunden wurde).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom Properties, die diese Komponente deklariert (@property) oder dokumentiert (@cssproperty).

functions ​

functions: CssFunction[]

CSS-Custom-Funktionen (@function), die diese Komponente definiert.

animations ​

animations: CssAnimation[]

Animationen (@keyframes), die diese Komponente bereitstellt.

layers ​

layers: CssLayer[]

Cascade-Layer (@layer), an denen diese Komponente teilnimmt.

conditions ​

conditions: CssCondition[]

Bedingte Support-Blöcke (@container/@supports/@media), unter denen die Regeln stehen.

examples ​

examples: string[]

@example-Blöcke, wortgetreu.

structure? ​

optional structure?: StructureNode[]

Der verfasste @structure-Elementbaum (Top-Level-Knoten), falls vorhanden. Wenn der @structure-Body @variant-Blöcke verwendet (siehe structureVariants), enthält dies nur die Knoten der ersten Variante, zur Abwärtskompatibilität mit Code, der noch nicht aktualisiert wurde, um structureVariants zu lesen.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternative DOM-Formen für diese Komponente, wenn der verfasste @structure-Body einen oder mehrere Top-Level-@variant-Blöcke enthält — fehlt im häufigen Fall einer einzelnen, nicht-varianten Struktur.

structureDescription? ​

optional structureDescription?: string

Eine optionale Textbeschreibung, die den @structure-Body einleitet, wenn sie verfasst wurde.

demo? ​

optional demo?: string

@demo <spec> (e.g. self:button), when authored.

deprecated? ​

optional deprecated?: string

Komponentenweite Deprecation-Ersatztexte, wenn verfasst (das Argument eines @deprecated-Tags).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Verwendungs-Text aus @usage — wie das Stylesheet einzubinden / die Komponente zu verwenden ist.

annotations ​

annotations: CssAnnotation[]

Lokale Annotations-Legendenzeilen aus @annotations, in Autorreihenfolge.

refs ​

refs: number[]

Lokale Annotierungsreferenzen aus @ref, in Autorreihenfolge.

decorators ​

decorators: CssDecorator[]

Record-weite Objektmodell-Decoratoren.

compat ​

compat: string[]

Browser-Unterstützungs- / Feature-Kompatibilitätsnotizen aus @compat.

related: CssRelated[]

Verwandte Komponenten aus @related.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarierte Mitgliedschaft in einer Familie aus @memberOf — dieser Eintrag ist Mitglied eines anderen benannten Eintrags, optional private (darf nur innerhalb dieses Elternteils erscheinen). Fehlend, wenn nicht verfasst.

members? ​

optional members?: string[]

Mitglieds-Eintragsnamen aus @members — die inverse Richtung, auf dem Elternteil deklariert.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturierte, auf Elternseite deklarierte Mitglieder aus wiederholten @member-Tags.

source? ​

optional source?: CssSource

Wo der Eintrag verfasst wurde, wenn Positionsinformationen verfügbar sind (für Quelllinks).

customBlocks? ​

optional customBlocks?: Record<string, string[]>

Inhalt registrierter benutzerdefinierter (Block-)Tags, indexiert nach dem Tag-Namen ohne dessen @. Wird nur für tags hinzugefügt, die über die Konfiguration hinzugefügt wurden; nicht registrierte, unbekannte Tags werden ignoriert. Fehlt, wenn keine gefunden wurden.