pantoken / renderers/tinymce/src / CssDocEntry

Gränssnitt: CssDocEntry ​

Ett dokumenterat CSS-record: dess basklass plus allt som härstammar från CSS + dokkommentarer.

Egenskaper ​

name ​

name: string

Record-namnet från @component/@utility/@rule/@declaration/@name, t.ex. button.

kind ​

kind: CssRecordKind

Vilken typ av CSS-yta detta dokumenterar (standard är component).

className ​

className: string

Bas-CSS-selektorn — en klass (.button), attribut ([data-layout="x"]), ID (#foo), eller shadow-DOM-pseudo (:host) — härlett från den första blottade klassregeln eller satt uttryckligen via @selector. Alltid icke-tom (återgår till .${name} när härledning misslyckas).

summary? ​

optional summary?: string

Enradig sammanfattning från @summary.

remarks? ​

optional remarks?: string

Utökad prosa från @remarks.

privateRemarks? ​

optional privateRemarks?: string

Endast-intern prosa från @privateRemarks (emittrar kan välja att utelämna den i publik output).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Utgivningsfas från en modifier-flaggtagg (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Version då det infördes, från @since.

group? ​

optional group?: string

En dokumentationsgrupp/kategori, från @group/@category.

accessibility? ​

optional accessibility?: string

Råd om tillgänglighet, från @a11y/@accessibility.

global? ​

optional global?: boolean

Satt när detta record bär en @global-tagg — dess modifierare (och per-modifier @global-flaggor) gäller för vilken komponent/layout/regeln/deklaration som helst, inte bara recordets basklass. Används vid validering och konsumtionskontroller för att lösa modifier-matcher globalt.

modifiers ​

modifiers: CssModifier[]

AST-extraherade modifierare, annoterade med @modifier-prosa där de är författade.

parts ​

parts: CssPart[]

AST-extraherade sub-elementdelar (klass-baserade), annoterade med @part-prosa där de är författade.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM-exponerade delar (::part(name)), från @csspart eller en ::part()-selektor.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native pseudo-element som komponenten stylar (::before, ::marker, …), från @pseudo eller en selektor.

states ​

states: CssState[]

Tillstånd som komponenten reagerar på, från @cssstate, :state(), pseudo-klasser eller tillståndsklasser.

slots ​

slots: CssSlot[]

Namngivna slots som komponentens shell exponerar, från @slot.

elements? ​

optional elements?: CssElementConstraints

Tillåtna HTML-element från @element (standard + valfria namngivna profiler).

todos ​

todos: string[]

Interna att-göra-anteckningar, från @todo-taggar och /* @todo … */ inline-kommentarer. Utvecklingsanteckningar, inte offentligt API — emittrar kan utelämna dem (som CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design-tokens som denna komponent använder: varje --* custom property refererad via var(...) i dess regler, var och en annoterad med @tokens-prosa där författad (och inklusive eventuella @tokens-deklarerade token som inte bokstavligen hittades via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom properties som denna komponent deklarerar (@property) eller dokumenterar (@cssproperty).

functions ​

functions: CssFunction[]

CSS custom-funktioner (@function) som denna komponent definierar.

animations ​

animations: CssAnimation[]

Animationer (@keyframes) som denna komponent exponerar.

layers ​

layers: CssLayer[]

Cascade-lager (@layer) som denna komponent deltar i.

conditions ​

conditions: CssCondition[]

Villkorsstödsblock (@container/@supports/@media) som reglerna ligger under.

examples ​

examples: string[]

@example-block, verbatim.

structure? ​

optional structure?: StructureNode[]

Den författade @structure elementträdet (top-nivå noder), när det finns. När @structure-kroppen använder @variant-block (se structureVariants), innehåller detta endast den första variantens noder, för bakåtkompatibilitet med kod som inte uppdaterats att läsa structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternativa DOM-former för denna komponent, när den författade @structure-kroppen innehåller en eller flera top-nivå @variant-block — frånvarande i det vanliga fallet med en enda, icke-variant struktur.

structureDescription? ​

optional structureDescription?: string

En valfri prosabeskrivning som leder @structure-kroppen, när författad.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Komponent-nivå ersättningstext för deprecation, när författad (argumentet till en @deprecated-tagg).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Användningsprosa från @usage — hur man inkluderar stylesheet / använder komponenten.

annotations ​

annotations: CssAnnotation[]

Lokala annoteringslegendrader från @annotations, i författarordning.

refs ​

refs: number[]

Lokala annoteringsreferenser från @ref, i författarordning.

decorators ​

decorators: CssDecorator[]

Record-nivå objektmodell-dekoratörer.

compat ​

compat: string[]

Anteckningar om webbläsarstöd / funktionskompatibilitet från @compat.

related: CssRelated[]

Relaterade komponenter från @related.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarerat familjemedlemskap från @memberOf — detta record är medlem i ett annat namngivet record, valfritt private (får endast förekomma inuti den parent). Frånvarande när inte författad.

members? ​

optional members?: string[]

Medlemsrecord-namn från @members — den omvända riktningen, deklarerad på parent.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturerade parent-sidans medlemsdeklarationer från upprepade @member-taggar.

source? ​

optional source?: CssSource

Var recordet författades, när positionsinfo finns (för käll-länkar).

customBlocks? ​

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

Innehåll i registrerade anpassade (block)taggar, indexerat efter taggnamn utan dess @. Fylls endast för taggar som lagts till via konfiguration; oregistrerade okända taggar ignoreras. Saknas när inga hittades.