pantoken / renderers/tinymce/src / CssDocEntry

Vmesnik: CssDocEntry ​

Ena dokumentirana CSS zapis: njegova osnovna razredna definicija in vse, kar izhaja iz CSS + doc komentarjev.

Lastnosti ​

name ​

name: string

Ime zapisa iz @component/@utility/@rule/@declaration/@name, npr. button.

kind ​

kind: CssRecordKind

Kakšen tip CSS površine to dokumentira (privzeto component).

className ​

className: string

Osnovni CSS selektor — razred (.button), atribut ([data-layout="x"]), ID (#foo), ali shadow-DOM pseudo (:host) — izpeljan iz prve pravilne razredne pravila ali nastavljen eksplicitno preko @selector. Vedno ni prazen (ob padcu se uporabi .${name}, če sklepanje ne uspe).

summary? ​

optional summary?: string

Enovrstični povzetek iz @summary.

remarks? ​

optional remarks?: string

Razširjena proza iz @remarks.

privateRemarks? ​

optional privateRemarks?: string

Proza samo za interno rabo iz @privateRemarks (emitorji se lahko odločijo, da jo izpustijo iz javnega izhoda).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Faza izida iz zastavice modifikatorja (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Različica, v kateri je bila uvedena, iz @since.

group? ​

optional group?: string

Skupina/kategorija dokumentacije, iz @group/@category.

accessibility? ​

optional accessibility?: string

Smernice za dostopnost, iz @a11y/@accessibility.

global? ​

optional global?: boolean

Nastavljeno, kadar ta zapis nosi @global tag — njegovi modifikatorji (in na-modifikator nivoju @global zastavice) veljajo za kateri koli komponento/postavitev/pravilo/deklaracijo, ne le za osnovni razred tega zapisa. Uporablja se pri preverjanju in potrošnji za globalno razreševanje ujemanj modifikatorjev.

modifiers ​

modifiers: CssModifier[]

Iz AST pridobljeni modifikatorji, opremljeni s prozo @modifier kjer je bila avtorsko dodana.

parts ​

parts: CssPart[]

Iz AST pridobljeni pod-elementni deli (na osnovi razredov), opremljeni s prozo @part kjer je bila avtorsko dodana.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM izpostavljeni deli (::part(name)), iz @csspart ali selektorja ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Nativni pseudo-elementi, s katerimi komponeta stilizira (::before, ::marker, …), iz @pseudo ali selektorja.

states ​

states: CssState[]

Stanja, na katera komponenta reagira, iz @cssstate, :state(), pseudo-razredov ali razredov stanja.

slots ​

slots: CssSlot[]

Poimenovani sloti, ki jih izpostavlja ovojnica komponente, iz @slot.

elements? ​

optional elements?: CssElementConstraints

Dovoljeni HTML elementi iz @element (privzeto + izbirni poimenovani profili).

todos ​

todos: string[]

Interna opravila (to-do) iz @todo tagov in /* @todo … */ vrstičnih komentarjev. Razvojne zapiske, ne javni API — emitorji jih lahko izpustijo (kot CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Oblikovni tokeni, ki jih ta komponenta uporablja: vsako --* lastnost po meri, sklicano preko var(...) znotraj njenih pravil, vsak označen z @tokens prozo, kjer je bila avtorsko dodana (in vključno z vsakim @tokens-deklariranim toknom, ki ni dobesedno najden preko var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Lastnosti po meri, ki jih ta komponenta deklarira (@property) ali dokumentira (@cssproperty).

functions ​

functions: CssFunction[]

CSS funkcije po meri (@function), ki jih ta komponenta definira.

animations ​

animations: CssAnimation[]

Animacije (@keyframes), ki jih ta komponenta izpostavlja.

layers ​

layers: CssLayer[]

Kaskadni sloji (@layer), v katerih ta komponenta sodeluje.

conditions ​

conditions: CssCondition[]

Pogoje podporne bloke (@container/@supports/@media), pod katerimi stojijo pravila.

examples ​

examples: string[]

@example bloki, dobesedno.

structure? ​

optional structure?: StructureNode[]

Avtorsko @structure drevo elementov (vrhnje vozlišča), ko je prisotno. Ko telo @structure uporablja @variant bloke (glej structureVariants), to drži samo vozlišča prve variante, zaradi združljivosti z obstoječo kodo, ki še ni posodobljena za branje structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternativne oblike DOM za to komponento, ko avtorsko telo @structure vsebuje eno ali več vrhnjih @variant blokov — odsotno v pogostem primeru enostrukih, ne-variantnih struktur.

structureDescription? ​

optional structureDescription?: string

Izbiren opis v prozi, ki vodi telo @structure, kadar je avtorsko dodan.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Besedilo na zamenjavo pri deprecaciji na nivoju komponente, kadar je avtorsko dodano (argument za @deprecated tag).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Proza z navodili za uporabo iz @usage — kako vključiti slogovnik / uporabljati komponento.

annotations ​

annotations: CssAnnotation[]

Vrstice legende lokalne anotacije iz @annotations, v avtorskem vrstnem redu.

refs ​

refs: number[]

Reference lokalnih anotacij iz @ref, v avtorskem vrstnem redu.

decorators ​

decorators: CssDecorator[]

Dekoratorji modela objekta na nivoju zapisa.

compat ​

compat: string[]

Opombe o podpori v brskalnikih / združljivosti funkcij iz @compat.

related: CssRelated[]

Povezane komponente iz @related.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarirano članstvo v družini iz @memberOf — ta zapis je član drugega poimenovanega zapisa, izbirno private (mora se pojaviti le znotraj tega nadrejenega). Odsotno, če ni avtorsko določeno.

members? ​

optional members?: string[]

Imena članov zapisa iz @members — obratna smer, deklarirana na nadrejenem.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturirane deklaracije članov na strani nadrejenega iz ponovljenih @member tagov.

source? ​

optional source?: CssSource

Kje je bil zapis avtorsko napisan, ko so na voljo informacije o položaju (za povezave na izvor).

customBlocks? ​

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

Vsebina registriranih lastnih (blokovnih) oznak, indeksirano po imenu oznake brez njenega @. Napolnjeno le za oznake dodane prek konfiguracije; neregistrirane neznane oznake so prezrte. Manjka, če ni bilo najdenih.