pantoken / renderers/tinymce/src / CssDocEntry

Interface: CssDocEntry ​

Eén gedocumenteerd CSS-record: de basis‑klasse plus alles dat is afgeleid van de CSS + doc‑commentaren.

Eigenschappen ​

name ​

name: string

De recordnaam uit @component/@utility/@rule/@declaration/@name, bijv. button.

kind ​

kind: CssRecordKind

Welk type CSS‑oppervlak dit documenteert (standaard component).

className ​

className: string

De basis CSS‑selector — een klasse (.button), attribuut ([data-layout="x"]), ID (#foo), of shadow‑DOM pseudo (:host) — afgeleid van de eerste bare‑class regel of expliciet ingesteld via @selector. Altijd niet‑leeg (valt terug op .${name} als afleiding faalt).

summary? ​

optional summary?: string

Eén‑regelige samenvatting uit @summary.

remarks? ​

optional remarks?: string

Uitgebreide prozatekst uit @remarks.

privateRemarks? ​

optional privateRemarks?: string

Alleen‑intern proza uit @privateRemarks (emitters kunnen ervoor kiezen dit weg te laten uit publieke output).

releaseStage? ​

optional releaseStage?: CssReleaseStage

De release‑fase vanuit een modifier‑vlagtag (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versie waarin geïntroduceerd, uit @since.

group? ​

optional group?: string

Een documentatiegroep/categorie, uit @group/@category.

accessibility? ​

optional accessibility?: string

Toegankelijkheidsrichtlijnen, uit @a11y/@accessibility.

global? ​

optional global?: boolean

Aangezet wanneer dit record een @global tag draagt — de modifiers (en per‑modifier @global vlaggen) zijn van toepassing op elk component/layout/regel/declaratie, niet alleen op de basis‑klasse van dit record. Gebruikt tijdens validatie en consumptiecontroles om modifier‑matches globaal op te lossen.

modifiers ​

modifiers: CssModifier[]

AST‑geëxtraheerde modifiers, geannoteerd met @modifier proza waar geschreven.

parts ​

parts: CssPart[]

AST‑geëxtraheerde sub‑element delen (klasse‑gebaseerd), geannoteerd met @part proza waar geschreven.

shadowParts ​

shadowParts: CssPart[]

Shadow‑DOM blootgestelde parts (::part(name)), afkomstig van @csspart of een ::part() selector.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native pseudo‑elementen waarop het component stijl toepast (::before, ::marker, …), vanuit @pseudo of een selector.

states ​

states: CssState[]

Staten waarop het component reageert, uit @cssstate, :state(), pseudo‑klassen of staat‑klassen.

slots ​

slots: CssSlot[]

Naamgegeven slots die de component‑shell blootstelt, uit @slot.

elements? ​

optional elements?: CssElementConstraints

Toegestane HTML‑elementen uit @element (standaard + optionele benoemde profielen).

todos ​

todos: string[]

Interne to‑do notities, uit @todo tags en /* @todo … */ inline opmerkingen. Ontwikkelnotities, geen publieke API — emitters kunnen ze weglaten (zoals CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design‑tokens die dit component gebruikt: elke --* custom property gerefereerd via var(...) binnen zijn regels, elk geannoteerd met @tokens proza waar geschreven (en inclusief elk @tokens‑gedekla­reerd token dat niet letterlijk is gevonden via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom properties die dit component declareert (@property) of documenteert (@cssproperty).

functions ​

functions: CssFunction[]

CSS custom functies (@function) die dit component definieert.

animations ​

animations: CssAnimation[]

Animaties (@keyframes) die dit component blootstelt.

layers ​

layers: CssLayer[]

Cascade‑lagen (@layer) waarin dit component participeert.

conditions ​

conditions: CssCondition[]

Conditionele‑supportblokken (@container/@supports/@media) waaronder de regels staan.

examples ​

examples: string[]

@example blokken, woordelijk.

structure? ​

optional structure?: StructureNode[]

De geauthorde @structure element‑boom (topniveau knooppunten), indien aanwezig. Wanneer het @structure body @variant blokken gebruikt (zie structureVariants), bevat dit alleen de knooppunten van de eerste variant, terug‑compatibiliteit voor code die nog niet is bijgewerkt om structureVariants te lezen.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternatieve DOM‑vormen voor dit component, wanneer de geauthorde @structure body één of meer top‑level @variant blokken bevat — afwezig in de gebruikelijke gevallen van een enkele, niet‑variant structuur.

structureDescription? ​

optional structureDescription?: string

Een optionele proza‑beschrijving die de @structure body voorafgaat, wanneer geschreven.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Component‑niveau deprecatie‑vervangtekst, indien geschreven (het argument van een @deprecated tag).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Gebruik‑proza uit @usage — hoe het stylesheet in te sluiten / het component te gebruiken.

annotations ​

annotations: CssAnnotation[]

Lokale annotatie‑legenda rijen uit @annotations, in auteurvolgorde.

refs ​

refs: number[]

Lokale annotatie‑referenties uit @ref, in auteurvolgorde.

decorators ​

decorators: CssDecorator[]

Record‑niveau object‑model decorators.

compat ​

compat: string[]

Browser‑ondersteunings / feature‑compatibiliteit notities uit @compat.

related: CssRelated[]

Gerelateerde componenten uit @related.

memberOf? ​

optional memberOf?: CssMemberOf

Gedeclareerd familielidmaatschap uit @memberOf — dit record is lid van een ander genoemd record, optioneel private (mag alleen binnen die ouder verschijnen). Afwezig wanneer niet geschreven.

members? ​

optional members?: string[]

Lid‑recordnamen uit @members — de inverse richting, gedeclareerd op de ouder.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Gestructureerde ouder‑zijde lid‑declaraties uit herhaalde @member tags.

source? ​

optional source?: CssSource

Waar het record is geauthord, wanneer positie‑info beschikbaar is (voor bronlinks).

customBlocks? ​

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

Inhoud van geregistreerde aangepaste (blok)tags, geïndexeerd op tagnaam zonder de @. Alleen gevuld voor tags die via configuratie zijn toegevoegd; niet-geregistreerde, onbekende tags worden genegeerd. Afwezig wanneer er geen zijn gevonden.