pantoken / renderers/tinymce/src / CssDocEntry

Interfész: CssDocEntry ​

Egy dokumentált CSS rekord: annak alaposztálya (base class) és minden, ami a CSS-ből + dokumentációs megjegyzésekből származik.

Tulajdonságok ​

name ​

name: string

A rekord neve a(z) @component/@utility/@rule/@declaration/@name elemből, pl. button.

kind ​

kind: CssRecordKind

Milyen típusú CSS felületet dokumentál ez (alapértelmezés szerint component).

className ​

className: string

Az alap CSS szelektor — egy osztály (.button), attribútum ([data-layout="x"]), azonosító (#foo), vagy shadow-DOM pszeudo (:host) —, amely az első tiszta osztály szabályból van kikövetkeztetve, vagy explicit módon beállítva a(z) @selector segítségével. Mindig nem üres (visszaesik a(z) .${name} értékre, ha a következtetés sikertelen).

summary? ​

optional summary?: string

Egysoros összefoglaló a(z) @summary elemből.

remarks? ​

optional remarks?: string

Részletes leírás a(z) @remarks elemből.

privateRemarks? ​

optional privateRemarks?: string

Kizárólag belső használatú leírás a(z) @privateRemarks elemből (a kibocsátók dönthetnek úgy, hogy kihagyják a nyilvános kimenetből).

releaseStage? ​

optional releaseStage?: CssReleaseStage

A kiadási fázis egy módosító jelzőcímkéből (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Bevezetés verziója, a(z) @since elemből.

group? ​

optional group?: string

Dokumentációs csoport/kategória a(z) @group/@category elemből.

accessibility? ​

optional accessibility?: string

Akadálymentesítési útmutatás a(z) @a11y/@accessibility elemből.

global? ​

optional global?: boolean

Akkor van beállítva, ha ez a rekord @global címkét hordoz — módosítói (és módosítónkénti @global jelzői) bármely komponensre/elrendezésre/szabályra/deklarációra érvényesek, nem csak a jelen rekord alaposztályára. Az érvényesítési és felhasználási ellenőrzések során használatos a módosító-egyezések globális feloldásához.

modifiers ​

modifiers: CssModifier[]

AST-ből kinyert módosítók, @modifier leírással kiegészítve ott, ahol megadták.

parts ​

parts: CssPart[]

AST-ből kinyert alelem-részek (osztályalapú), @part leírással kiegészítve ott, ahol megadták.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM által közzétett részek (::part(name)), a(z) @csspart elemből vagy egy ::part() szelektor alapján.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Natív pszeudoelemek, amelyeket a komponens stílusoz (::before, ::marker, …), a(z) @pseudo elemből vagy egy szelektor alapján.

states ​

states: CssState[]

Állapotok, amelyekre a komponens reagál: @cssstate, :state(), pszeudoosztályok vagy állapot-osztályok alapján.

slots ​

slots: CssSlot[]

A komponenshéj által közzétett nevesített slotok a(z) @slot alapján.

elements? ​

optional elements?: CssElementConstraints

Engedélyezett HTML-elemek a(z) @element alapján (alapértelmezett + opcionális elnevezett profilok).

todos ​

todos: string[]

Belső teendő megjegyzések a(z) @todo címkékből és a(z) /* @todo … */ sorközi megjegyzésekből. Fejlesztési megjegyzések, nem nyilvános API – az emitterek kihagyhatják őket (mint a CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

A komponens által felhasznált designtokenek: minden olyan --* egyéni tulajdonság, amelyre a szabályain belül a(z) var(...) hivatkozik, mindegyik @tokens leírással ellátva, ahol megadták (beleértve minden olyan @tokens által deklarált tokent is, amely szó szerint nem található meg a(z) var() használatával).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Egyéni tulajdonságok, amelyeket ez a komponens deklarál (@property) vagy dokumentál (@cssproperty).

functions ​

functions: CssFunction[]

CSS egyéni függvények (@function), amelyeket ez a komponens definiál.

animations ​

animations: CssAnimation[]

Animációk (@keyframes), amelyeket ez a komponens közzétesz.

layers ​

layers: CssLayer[]

Kaszkádrétegek (@layer), amelyekben ez a komponens részt vesz.

conditions ​

conditions: CssCondition[]

Feltételes támogatási blokkok (@container/@supports/@media), amelyek alatt a szabályok találhatók.

examples ​

examples: string[]

@example blokkok, szó szerint.

structure? ​

optional structure?: StructureNode[]

A megírt @structure elemfa (legfelső szintű csomópontok), amennyiben jelen van. Amikor a(z) @structure törzse @variant blokkokat használ (lásd: structureVariants), ez csak az első variáns csomópontjait tartalmazza, a visszamenőleges kompatibilitás érdekében az olyan kódokkal, amelyeket még nem frissítettek a(z) structureVariants olvasására.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternatív DOM-struktúrák ehhez a komponenshez, ha a megírt @structure törzs egy vagy több legfelső szintű @variant blokkot tartalmaz – hiányzik az egyetlen, nem variáns struktúra gyakori esetében.

structureDescription? ​

optional structureDescription?: string

Egy opcionális leíró szöveg a(z) @structure törzsének elején, amennyiben meg van adva.

demo? ​

optional demo?: string

@demo <spec> (pl. self:button), amennyiben meg van adva.

deprecated? ​

optional deprecated?: string

Komponensszintű elavulási helyettesítő szöveg, amennyiben meg van adva (egy @deprecated címke argumentuma).

see ​

see: string[]

@see <ref> kereszthivatkozások.

usage? ​

optional usage?: string

Használati útmutató szöveg a(z) @usage alapján – hogyan illesszük be a stíluslapot / használjuk a komponenst.

annotations ​

annotations: CssAnnotation[]

Helyi annotációs jelmagyarázat-sorok a(z) @annotations alapján, szerzői sorrendben.

refs ​

refs: number[]

Helyi annotációs hivatkozások a(z) @ref alapján, szerzői sorrendben.

decorators ​

decorators: CssDecorator[]

Rekordszintű objektummodell-dekorátorok.

compat ​

compat: string[]

Böngészőtámogatási / funkciókompatibilitási megjegyzések a(z) @compat alapján.

related: CssRelated[]

Kapcsolódó komponensek a(z) @related alapján.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarált családtagság a(z) @memberOf alapján – ez a rekord egy másik elnevezett rekord tagja, opcionálisan private (csak és kizárólag az adott szülőn belül jelenhet meg). Hiányzik, ha nincs megadva.

members? ​

optional members?: string[]

Tagrekordnevek a(z) @members alapján – az ellenkező irány, a szülőn deklarálva.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturált szülőoldali tagdeklarációk ismételt @member címkékből.

source? ​

optional source?: CssSource

A rekord forráshelye, ha a pozícióinformációk elérhetők (forráshivatkozásokhoz).

customBlocks? ​

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

Regisztrált egyéni (blokk) címkék tartalma, címkenév szerint kulcsozva a(z) @ nélkül. Csak a konfiguráción keresztül hozzáadott címkék esetén feltöltve; a nem regisztrált ismeretlen címkék figyelmen kívül lesznek hagyva. Hiányzik, ha egy sem található.