pantoken / renderers/tinymce/src / CssDocEntry

Entèfas: CssDocEntry ​

Youn dosye CSS dokimante: klas baz li ansanm ak tout sa ki sòti nan CSS + kòmantè dokimantasyon yo.

Pwopriyete ​

name ​

name: string

Non dosye a soti nan @component/@utility/@rule/@declaration/@name, e.g. button.

kind ​

kind: CssRecordKind

Ki kalite sifas CSS dokimante sa a ye (default se component).

className ​

className: string

Selektè CSS baz la — yon klas (.button), atribi ([data-layout="x"]), ID (#foo), oswa pseudo shadow-DOM (:host) — dedwi soti nan premye règ bare-class la oswa fikse eksplisitman via @selector. Toujou pa vid (retounen sou .${name} lè enfèrans echwe).

summary? ​

optional summary?: string

Rezime yon liy soti nan @summary.

remarks? ​

optional remarks?: string

Pwosè elaji soti nan @remarks.

privateRemarks? ​

optional privateRemarks?: string

Tèks pou itilizasyon entèn sèlman soti nan @privateRemarks (emitè yo ka chwazi pa enkli li nan rezilta piblik).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Nivo lage a soti nan yon tag drapo modifikatè (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Vèsyon kote li te entwodui, soti nan @since.

group? ​

optional group?: string

Yon gwoup/kategori dokimantasyon, soti nan @group/@category.

accessibility? ​

optional accessibility?: string

Gid aksèbilite, soti nan @a11y/@accessibility.

global? ​

optional global?: boolean

Mete lè dosye sa pote yon tag @global — modifikatè li yo (ak drapo pou chak-modifikatè @global) aplike a nenpòt konpozan/konpozisyon/règ/deklare, pa sèlman klas baz dosye sa a. Itilize pandan validasyon ak chèk konsomasyon pou rezoud matche modifikatè globalman.

modifiers ​

modifiers: CssModifier[]

Modifikatè ekstrè soti nan AST la, anote ak @modifier tèks kote yo te ekri.

parts ​

parts: CssPart[]

Pati sib-eleman ekstrè soti nan AST la (ki baze sou klas)), anote ak @part tèks kote yo te ekri.

shadowParts ​

shadowParts: CssPart[]

Patisyon ekspoze pa Shadow-DOM (::part(name)), soti nan @csspart oswa yon selektè ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-eleman natif-natal estil konpozan an (::before, ::marker, …), soti nan @pseudo oswa yon selektè.

states ​

states: CssState[]

Eta konpozan an reponn a yo, soti nan @cssstate, :state(), pseudo-classes, oswa klas eta.

slots ​

slots: CssSlot[]

Slot ki gen non ke kich la ekspoze, soti nan @slot.

elements? ​

optional elements?: CssElementConstraints

Eleman HTML ki pèmèt soti nan @element (defo + pwofil nonmen opsyonèl).

todos ​

todos: string[]

Nòt entèns travay-a-fè, soti nan @todo tags ak /* @todo … */ kòmantè inline. Nòt devlopman, pa API piblik — emitè yo ka pa enkli yo (tankou CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokens konsepsyon konpozan sa a konsome: chak --* pwopriyete koutim refere atravè var(...) andedan règ li yo, chak anote ak @tokens tèks kote yo te ekri (epi enkli nenpòt @tokens-deklae token ki pa literalman jwenn via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Pwopriyete koutim konpozan sa a deklare (@property) oswa dokimante (@cssproperty).

functions ​

functions: CssFunction[]

Fonksyon koutim CSS (@function) ke konpozan sa a defini.

animations ​

animations: CssAnimation[]

Animasyon (@keyframes) ke konpozan sa a ekspoze.

layers ​

layers: CssLayer[]

Kouch kaskad (@layer) ke konpozan sa a patisipe ladanl.

conditions ​

conditions: CssCondition[]

Blòk sipò kondisyonèl (@container/@supports/@media) anba ki règ yo chita.

examples ​

examples: string[]

@example blòk, vèbatim.

structure? ​

optional structure?: StructureNode[]

Pyebwa eleman otè a ekri a @structure (nœuds tèt-nivo), lè prezan. Lè kò a @structure itilize @variant blòk (gade structureVariants), sa a kenbe nœuds premye varyant lan sèlman, pou konpatibilite bak ak nenpòt kòd ki poko mete ajou pou li li structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Fòm DOM altènatif pou konpozan sa a, lè kò otè a @structure gen youn oswa plis blòk tèt-nivo @variant — absan pou ka komen kote gen yon sèl estrikti san varyant.

structureDescription? ​

optional structureDescription?: string

Yon deskripsyon pwosè opsyonèl ki mennen kò @structure, lè li ekri.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Tèks ranplasman deprekasyo nivo konpozan, lè li ekri (agiman pou yon tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Pwosè itilizasyon soti nan @usage — kijan pou enkli fichyè stil la / itilize konpozan an.

annotations ​

annotations: CssAnnotation[]

Ranje lejand anotasyon lokal soti nan @annotations, nan lòd otè a.

refs ​

refs: number[]

Referans anotasyon lokal soti nan @ref, nan lòd otè a.

decorators ​

decorators: CssDecorator[]

Dekoratè modèl-objè nan nivo dosye a.

compat ​

compat: string[]

Nòt sipò navigatè / konpatibilite karakteristik soti nan @compat.

related: CssRelated[]

Konpozan ki gen rapò soti nan @related.

memberOf? ​

optional memberOf?: CssMemberOf

Membreship fanmi deklare soti nan @memberOf — dosye sa a se yon manm yon lòt dosye nonmen, opsyonèlman private (dwe parèt sèlman andedan paran sa a). Absan lè pa otè.

members? ​

optional members?: string[]

Non dosye manm soti nan @members — direksyon envès, deklare sou paran an.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Deklarasyon manm estriktire sou bò paran an soti nan repete tag @member.

source? ​

optional source?: CssSource

Kote dosye a te ekri, lè enfòmasyon pozisyon disponib (pou lyen sous)).

customBlocks? ​

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

Kontni tag koutim (blòk) ki anrejistre yo, endèks pa non tag la san @. Ranpli sèlman pou tag yo ajoute atravè konfigirasyon; tag enkoni ki pa anrejistre yo inyore. Pa prezan lè pa gen okenn ki te jwenn.