pantoken / renderers/tinymce/src / CssDocEntry

Grensesnitt: CssDocEntry ​

Én dokumentert CSS-post: dens basisklasse pluss alt avledet fra CSS + doc-kommentarer.

Egenskaper ​

name ​

name: string

Postnavnet fra @component/@utility/@rule/@declaration/@name, f.eks. button.

kind ​

kind: CssRecordKind

Hvilken type CSS-flate dette dokumenterer (standard er component).

className ​

className: string

Den grunnleggende CSS-selektoren — en klasse (.button), attributt ([data-layout="x"]), ID (#foo), eller shadow-DOM pseudo (:host) — utledet fra den første bare-klasse-regelen eller satt eksplisitt via @selector. Alltid ikke-tom (faller tilbake til .${name} når utledning mislykkes).

summary? ​

optional summary?: string

Én-linjers oppsummering fra @summary.

remarks? ​

optional remarks?: string

Utvidet prosa fra @remarks.

privateRemarks? ​

optional privateRemarks?: string

Internt-only prosa fra @privateRemarks (emittere kan velge å utelate dette fra offentlig output).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Utgivelseskategori fra et modifikatortagg (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versjon der den ble introdusert, fra @since.

group? ​

optional group?: string

En dokumentasjonsgruppe/kategori, fra @group/@category.

accessibility? ​

optional accessibility?: string

Veiledning for tilgjengelighet, fra @a11y/@accessibility.

global? ​

optional global?: boolean

Satt når denne posten har et @global-tagg — dens modifikatorer (og per-modifikator @global-flagg) gjelder for enhver komponent/lay-out/regel/deklarasjon, ikke bare denne postens basisklasse. Brukes under validering og konsumkontroller for å løse modifikatormatcher globalt.

modifiers ​

modifiers: CssModifier[]

AST-ekstraherte modifikatorer, annotert med @modifier-prosa hvor forfattet.

parts ​

parts: CssPart[]

AST-ekstraherte sub-elementdeler (klassebaserte), annotert med @part-prosa hvor forfattet.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM eksponerte parts (::part(name)), fra @csspart eller en ::part()-selektor.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native pseudo-elementer komponenten styler (::before, ::marker, …), fra @pseudo eller en selektor.

states ​

states: CssState[]

Tilstander komponenten reagerer på, fra @cssstate, :state(), pseudo-klasser eller tilstandsklasser.

slots ​

slots: CssSlot[]

Navngitte slots som komponentens shell eksponerer, fra @slot.

elements? ​

optional elements?: CssElementConstraints

Tillatte HTML-elementer fra @element (standard + valgfrie navngitte profiler).

todos ​

todos: string[]

Interne TODO-notater, fra @todo-tagger og /* @todo … */ inline-kommentarer. Utviklingsnotater, ikke offentlig API — emittere kan utelate dem (som CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design tokens denne komponenten bruker: hver --*-custom property referert via var(...) inne reglene, hver annotert med @tokens-prosa hvor forfattet (og inkludert enhver @tokens-deklarert token som ikke bokstavelig ble funnet via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom properties denne komponenten definerer (@property) eller dokumenterer (@cssproperty).

functions ​

functions: CssFunction[]

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

animations ​

animations: CssAnimation[]

Animasjoner (@keyframes) denne komponenten eksponerer.

layers ​

layers: CssLayer[]

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

conditions ​

conditions: CssCondition[]

Betingede støtteblokker (@container/@supports/@media) reglene ligger under.

examples ​

examples: string[]

@example-blokker, ordrett.

structure? ​

optional structure?: StructureNode[]

Det forfattede @structure element-treet (top-nivå noder), når det finnes. Når @structure-innholdet bruker @variant-blokker (se structureVariants), inneholder dette kun første variantens noder, for bakoverkompatibilitet med kode som ikke er oppdatert til å lese structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternative DOM-former for denne komponenten, når det forfattede @structure-innholdet inneholder én eller flere top-nivå @variant-blokker — fraværende i det vanlige tilfellet med en enkelt, ikke-variant struktur.

structureDescription? ​

optional structureDescription?: string

En valgfri prosa-beskrivelse som leder @structure-innholdet, når forfattet.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Komponent-nivå erstatningstekst ved avskriving, når forfattet (argumentet til et @deprecated-tagg).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Bruksprosa fra @usage — hvordan inkludere stylesheet / bruke komponenten.

annotations ​

annotations: CssAnnotation[]

Rader i lokal annotasjonsforklaring fra @annotations, i forfatterrekkefølge.

refs ​

refs: number[]

Lokale annotasjonsreferanser fra @ref, i forfatterrekkefølge.

decorators ​

decorators: CssDecorator[]

Post-nivå objektmodell-dekoratører.

compat ​

compat: string[]

Nettleserstøtte / funksjonskompatibilitetsnotater fra @compat.

related: CssRelated[]

Relaterte komponenter fra @related.

memberOf? ​

optional memberOf?: CssMemberOf

Erklært familietilhørighet fra @memberOf — denne posten er medlem av en annen navngitt post, valgfritt private (må kun forekomme inne i den parenten). Fraværende når ikke forfattet.

members? ​

optional members?: string[]

Medlems-postnavn fra @members — den inverse retningen, erklært på parenten.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturerte parent-side medlems-erklæringer fra gjentatte @member-tagger.

source? ​

optional source?: CssSource

Hvor posten ble forfattet, når posisjonsinfo er tilgjengelig (for kildelenker).

customBlocks? ​

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

Innholdet i registrerte egendefinerte (blokk) tagger, indeksert etter taggnavn uten sin @. Fylles kun for tagger lagt til via konfigurasjon; uregistrerede ukjente tagger ignoreres. Fraværende når ingen ble funnet.