pantoken / renderers/tinymce/src / CssDocEntry

Interfaccia: CssDocEntry ​

Un record CSS documentato: la sua classe base più tutto ciò che è derivato dal CSS + commenti di documentazione.

Proprietà ​

name ​

name: string

Il nome del record da @component/@utility/@rule/@declaration/@name, es. button.

kind ​

kind: CssRecordKind

Quale tipo di superficie CSS documenta (default component).

className ​

className: string

Il selettore CSS di base — una classe (.button), un attributo ([data-layout="x"]), un ID (#foo), o un pseudo dello shadow-DOM (:host) — dedotto dalla prima regola bare-class o impostato esplicitamente tramite @selector. Sempre non vuoto (torna a .${name} se l'inferenza fallisce).

summary? ​

optional summary?: string

Sommario in una riga da @summary.

remarks? ​

optional remarks?: string

Prosa estesa da @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prosa solo interna da @privateRemarks (gli emitter possono scegliere di ometterla dall'output pubblico).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Lo stage di rilascio da un tag flag modificatore (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versione in cui è stata introdotta, da @since.

group? ​

optional group?: string

Un gruppo/categoria di documentazione, da @group/@category.

accessibility? ​

optional accessibility?: string

Linee guida per l'accessibilità, da @a11y/@accessibility.

global? ​

optional global?: boolean

Impostato quando questo record porta un tag @global — i suoi modificatori (e i flag @global per modificatore) si applicano a qualsiasi componente/layout/regola/dichiarazione, non solo alla classe base di questo record. Usato durante la validazione e i controlli di consumo per risolvere le corrispondenze dei modificatori globalmente.

modifiers ​

modifiers: CssModifier[]

Modificatori estratti dall'AST, annotati con prosa @modifier dove scritta.

parts ​

parts: CssPart[]

Sottoparti estratte dall'AST (basate su classi), annotate con prosa @part dove scritta.

shadowParts ​

shadowParts: CssPart[]

Parts esposte dallo Shadow-DOM (::part(name)), da @csspart o da un selettore ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elementi nativi che gli stili del componente usano (::before, ::marker, …), da @pseudo o da un selettore.

states ​

states: CssState[]

Stati a cui il componente reagisce, da @cssstate, :state(), pseudo-classi o classi di stato.

slots ​

slots: CssSlot[]

Slot nominati che la shell del componente espone, da @slot.

elements? ​

optional elements?: CssElementConstraints

Elementi HTML consentiti da @element (profilo di default + profili nominati opzionali).

todos ​

todos: string[]

Note interne to-do, da tag @todo e commenti inline /* @todo … */. Note di sviluppo, non API pubblica — gli emitter possono ometterle (come CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Token di design che questo componente consuma: ogni proprietà personalizzata --* referenziata tramite var(...) nelle sue regole, ciascuna annotata con prosa @tokens dove scritta (e includendo qualsiasi token dichiarato con @tokens non trovato letteralmente tramite var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Proprietà personalizzate che questo componente dichiara (@property) o documenta (@cssproperty).

functions ​

functions: CssFunction[]

Funzioni CSS custom (@function) che questo componente definisce.

animations ​

animations: CssAnimation[]

Animazioni (@keyframes) che questo componente espone.

layers ​

layers: CssLayer[]

Cascade layers (@layer) a cui questo componente partecipa.

conditions ​

conditions: CssCondition[]

Blocchi di supporto condizionale (@container/@supports/@media) sotto i quali risiedono le regole.

examples ​

examples: string[]

Blocchi @example, in forma letterale.

structure? ​

optional structure?: StructureNode[]

L'albero di elementi @structure scritto dall'autore (nodi di primo livello), se presente. Quando il corpo @structure usa blocchi @variant (vedi structureVariants), questo contiene solo i nodi della prima variante, per retrocompatibilità con codice che non è stato aggiornato per leggere structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Forme DOM alternative per questo componente, quando il corpo @structure scritto dall'autore contiene una o più top-level @variant blocks — assente per il caso comune di una struttura singola, non variante.

structureDescription? ​

optional structureDescription?: string

Una descrizione in prosa opzionale che precede il corpo @structure, se scritta.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Testo di sostituzione per deprecazione a livello di componente, se scritto (l'argomento di un tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa d'uso da @usage — come includere il foglio di stile / usare il componente.

annotations ​

annotations: CssAnnotation[]

Righe della legenda di annotazione locale da @annotations, nell'ordine dell'autore.

refs ​

refs: number[]

Riferimenti di annotazione locale da @ref, nell'ordine dell'autore.

decorators ​

decorators: CssDecorator[]

Decorator dell'object-model a livello di record.

compat ​

compat: string[]

Note sul supporto nei browser / compatibilità delle funzionalità da @compat.

related: CssRelated[]

Componenti correlati da @related.

memberOf? ​

optional memberOf?: CssMemberOf

Appartenenza alla famiglia dichiarata da @memberOf — questo record è membro di un altro record nominato, opzionalmente private (deve apparire solo all'interno di quel genitore). Assente se non scritto.

members? ​

optional members?: string[]

Nomi dei record membri da @members — la direzione inversa, dichiarata sul genitore.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Dichiarazioni strutturate di membri lato genitore da ripetuti tag @member.

source? ​

optional source?: CssSource

Dove il record è stato scritto, quando le informazioni di posizione sono disponibili (per link alla sorgente).

customBlocks? ​

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

Contenuto dei tag personalizzati registrati (block), indicizzati per nome del tag senza il suo @. Popolato solo per tag aggiunti tramite la configurazione; i tag sconosciuti non registrati sono ignorati. Assente quando non ne sono stati trovati.