pantoken / renderers/tinymce/src / CssDocEntry

Grensesnitt: CssDocEntry ​

Eitt dokumentert CSS-oppføring: baseklassen og alt som er avleidd frå CSS + dokkommentarane.

Eigenskapar ​

name ​

name: string

Oppføringsnamnet frå @component/@utility/@rule/@declaration/@name, t.d. button.

kind ​

kind: CssRecordKind

Kva slags CSS-flate dette dokumenterer (standard: component).

className ​

className: string

Den grunnleggande CSS-selektoren — ein klasse (.button), attributt ([data-layout="x"]), ID (#foo), eller shadow-DOM-pseudo (:host) — utoverført frå den første bare-klasse-regelen eller sett eksplisitt via @selector. Alltid ikkje-tom (fell tilbake til .${name} når inferens feilar).

summary? ​

optional summary?: string

Einlinje-samanfatning frå @summary.

remarks? ​

optional remarks?: string

Utvida prosa frå @remarks.

privateRemarks? ​

optional privateRemarks?: string

Intern-prosa frå @privateRemarks (emitørar kan velje å utelate dette i offentleg output).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Utgjevingstrinnet frå eit modifikator-flaggtagg (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versjon introdusert, frå @since.

group? ​

optional group?: string

Ei dokumentasjonsgruppe/kategori, frå @group/@category.

accessibility? ​

optional accessibility?: string

Tilgjengelegheitsrettleiing, frå @a11y/@accessibility.

global? ​

optional global?: boolean

Set når denne oppføringa har eit @global-tagg — modifikatorane (og per-modifikator @global-flagga) gjelder for alle komponentar/layout/reglar/deklarasjonar, ikkje berre denne oppføringens baseklasse. Brukt under validering og forbrukarkontroll for å løyse modifikator-matchar globalt.

modifiers ​

modifiers: CssModifier[]

AST-uttrekte modifikatorar, annoterte med @modifier-prosa der det er forfatta.

parts ​

parts: CssPart[]

AST-uttrekte under-elementdelar (klasse-baserte), annoterte med @part-prosa der det er forfatta.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM-eksponerte delar (::part(name)), frå @csspart eller ein ::part()-selektor.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native pseudo-element som komponenten stiliserer (::before, ::marker, …), frå @pseudo eller ein selektor.

states ​

states: CssState[]

Tilstandar komponenten reagerer på, frå @cssstate, :state(), pseudo-klassar eller tilstandsklassar.

slots ​

slots: CssSlot[]

Namngjevne slots som komponent-skallet eksponerer, frå @slot.

elements? ​

optional elements?: CssElementConstraints

Tillatne HTML-element frå @element (standard + valfrie namngjevne profiler).

todos ​

todos: string[]

Interne to-do-merknader, frå @todo-taggar og /* @todo … */ inline-kommentarar. Utviklarmerknader, ikkje offentleg API — emitørar kan utelate dei (som CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Designtokenar denne komponenten brukar: kvar --*-custom-property referert via var(...) inne reglane, kvar annotert med @tokens-prosa der forfatta (og inkludert eventuelle @tokens-deklarerte token som ikkje bokstaveleg vart funne via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom-properties denne komponenten erklærer (@property) eller dokumenterer (@cssproperty).

functions ​

functions: CssFunction[]

CSS custom-funksjonar (@function) denne komponenten definerer.

animations ​

animations: CssAnimation[]

Animasjonar (@keyframes) denne komponenten eksponerer.

layers ​

layers: CssLayer[]

Cascade-lag (@layer) denne komponenten deltek i.

conditions ​

conditions: CssCondition[]

Betinga-støtte-blokkar (@container/@supports/@media) reglane ligg under.

examples ​

examples: string[]

@example-blokkar, ordrett.

structure? ​

optional structure?: StructureNode[]

Den forfattarde @structure element-treet (top-nivå noder), når tilstades. Når @structure-kroppen bruker @variant-blokkar (sjå structureVariants), held dette berre første variantens nodar, for bakoverkompatibilitet med kode som ikkje er oppdatert til å lese structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternative DOM-former for denne komponenten, når den forfattarde @structure-kroppen inneheld éin eller fleire top-nivå @variant-blokkar — fråverande i det vanlege tilfellet med ein enkelt, ikkje-variant struktur.

structureDescription? ​

optional structureDescription?: string

Ei valfri prosa-beskriving som leiar @structure-kroppen, når forfatta.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Komponentnivå erstatningstekst ved deprekasjon, når forfatta (argumentet til eit @deprecated-tagg).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Bruksprosa frå @usage — korleis å inkludere stylesheet / bruke komponenten.

annotations ​

annotations: CssAnnotation[]

Lokale annotasjons-legenderekker frå @annotations, i forfattarrekkefølgje.

refs ​

refs: number[]

Lokale annotasjonsreferansar frå @ref, i forfattarrekkefølgje.

decorators ​

decorators: CssDecorator[]

Oppføringsnivå objektmodell-dekoratørar.

compat ​

compat: string[]

Nettlesar-støtte / featur-kompatibilitetsmerknader frå @compat.

related: CssRelated[]

Relaterte komponentar frå @related.

memberOf? ​

optional memberOf?: CssMemberOf

Erklært familiemedlemskap frå @memberOf — denne oppføringa er medlem av ein annan namngjeven oppføring, valfritt private (må berre førekome inni den forelderen). Fråverande når ikkje forfatta.

members? ​

optional members?: string[]

Medlemsoppføringsnamn frå @members — den inverse retninga, erklært på forelderen.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturerte foreldre-side medlems-erklæringar frå gjentekne @member-taggar.

source? ​

optional source?: CssSource

Kor oppføringa vart forfatta, når posisjonsinformasjon er tilgjengeleg (for kjelde-lenkjer).

customBlocks? ​

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

Innhaldet til registrerte, tilpassa (blokk)‑taggar, indeksert etter taggnamnet utan @. Fyllast berre for taggar som er lagde til via konfigurasjon; uregistrerte eller ukjende taggar blir ignorert. Fråverande når ingen vart funne.