pantoken / renderers/tinymce/src / CssDocEntry

Interfáhta: CssDocEntry ​

Okta dokumentera CSS-rekord: su gaskalassa ja buot mii leat geargan CSS + doc-kommentáraid-bargguidl.

Properties ​

name ​

name: string

Rekordnamma dihtii @component/@utility/@rule/@declaration/@name, dánne mii button.

kind ​

kind: CssRecordKind

Maid CSS-surface leaba dá dokumenteravuođa (default lea component).

className ​

className: string

Gaskal CSS-selector — klassa (.button), atributta ([data-layout="x"]), ID (#foo), dahje shadow-DOM pseudo (:host) — ožžohahtti oktasaš ferte bare-class rule dahje setta erenoamážit olbmuid @selector. Leage maid don galgá (fall-back lea .${name} go ožžohahtti ii čađe).

summary? ​

optional summary?: string

Ođđa-line summarjii dihtii @summary.

remarks? ​

optional remarks?: string

Vuođđud mieldeproosa dihtii @remarks.

privateRemarks? ​

optional privateRemarks?: string

Sisohkeproosa: in-ovttas muhtin @privateRemarks (emittera sáhttet valá omboddáit vuođđud-juohkit).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Gulahallat vástádus-stádiuvdna modifier-flag tagas (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versiovnna mii eret, dihtii @since.

group? ​

optional group?: string

Dokumentaššuvnna gruppa/kattegorija, dihtii @group/@category.

accessibility? ​

optional accessibility?: string

Gulahallat suddjenvuohta, dihtii @a11y/@accessibility.

global? ​

optional global?: boolean

Setta go dát rekordda lea @global tagas — modifieraid (ja modifier-juo @global flaggat) sávvá komponenta/layout/rule/declaration guovttos, ii doarvái dan rekorda gaskalclassas. Geavahuvvo validereamiin ja konsumereamiin mii rievdadus modifier-matcahte mielddis gaskaldugal.

modifiers ​

modifiers: CssModifier[]

AST-ođđahtte modifierat, annoterade @modifier proosaga go álbmot guhkes.

parts ​

parts: CssPart[]

AST-ođđahtte sub-element parte (class-based), annoterade @part proosaga go álbmot guhkes.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM ovttas partes (::part(name)), dihtii @csspart/ dahje ::part() selectoris.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Native pseudo-elementat mii komponenta styles árvvo (::before, ::marker, …), dihtii @pseudo/ dahje selectoris.

states ​

states: CssState[]

Státusat mii komponenta reacte, dihtii @cssstate, :state(), pseudo-klassat dahje státusklassat.

slots ​

slots: CssSlot[]

Nammande slotat mii komponenta shell ovttá, dihtii @slot.

elements? ​

optional elements?: CssElementConstraints

Oktage HTML-elementat dihtii @element (default + válgá namma profila).

todos ​

todos: string[]

Sisohke to-do muhtunotat, dihtii @todo taggat ja /* @todo … */ inline-kommentárat. Dástu bargguid, ii publika API — emitterat sáhttet valá vuostádit (njeallje CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design-tokenat mii dát komponenta geavahuu: buot --* custom-property mii lea birra var(...) ruleis, jagi annoterehta @tokens proosaga go álbmot guhkes (ja sisá @tokens-geavaheap token mii ii leat literaalalaš vuostta var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom-propertyat mii dát komponenta deklarera (@property) dahje dokumentere (@cssproperty).

functions ​

functions: CssFunction[]

CSS custom-funktioanat (@function) mii dát komponenta definera.

animations ​

animations: CssAnimation[]

Animasjonaat (@keyframes) mii dát komponenta ovttá.

layers ​

layers: CssLayer[]

Cascade-layers (@layer) mii dát komponenta leat gieđahallan.

conditions ​

conditions: CssCondition[]

Conditional-support blokkat (@container/@supports/@media) mii ruleat leat vuostá.

examples ​

examples: string[]

@example blokkat, verbatim.

structure? ​

optional structure?: StructureNode[]

Authored @structure element-tree (top-level nodes), gos divtta. Go @structure bodde geavahus @variant blokkat (vaikko structureVariants), danne dat lea doarvuohta oktasaš variantta nodes vuollá, bures addjá-compatibility koda mii ii leat oahppan šat structureVariants čállá.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternatiiva DOM-formát dá komponenta, gos authored @structure bodda leat oktan dahje muitu top-level @variant blokkat — ávžžut go stuorra máŋga, dáid lea absent go ovttas juohkke struktura.

structureDescription? ​

optional structureDescription?: string

Valjuhus prose-beskrivaššuvdna mii johtá @structure bodda, gos authored.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Komponent-level deprecation replace-text, gos authored (argumentta @deprecated tagas).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Geavahus-proosda dihtii @usage — kako duorat stylesheetis / geavahit komponenta.

annotations ​

annotations: CssAnnotation[]

Lokal annotaššuvnna legend-ráddat dihtii @annotations, author-ordera.

refs ​

refs: number[]

Lokal annotaššuvnna referáhkkat dihtii @ref, author-ordera.

decorators ​

decorators: CssDecorator[]

Rekord-level objekt-model decoratorat.

compat ​

compat: string[]

Browserverranastit / feature-kompatibilitehta muhtunotat dihtii @compat.

related: CssRelated[]

Gulahallat komponentat dihtii @related.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarera familia-mánáid dihtii @memberOf — dát rekordda lea mánáda vuolde geldni rekorda, váile private (máste doarvái máilmmis šaddat dan parent-suinna). Ávžžut go ii leat authored.

members? ​

optional members?: string[]

Member-record nammat dihtii @members — inverse direkšuvdna, deklarera parentis.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturerda parent-side member-deklaratsioonat dihtii repetera @member taggáid.

source? ​

optional source?: CssSource

Gode ahte rekorda lea čállán, go position-informášaš leat (sourcelinkkalaš) .

customBlocks? ​

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

Registrerejuvvan muhtun (blokša) taggáid sisältõ, taggán nemean maid ii leat @. Báhcet doarvái nu ahte taggát leat konfiguráhttašuvvon addan; ovttas unregistrerejuvvan taggát leat ignorerahttu. Eai leat mii go eai leat máhttit.