pantoken / renderers/tinymce/src / CssDocEntry

Rajapinta: CssDocEntry ​

Yksi dokumentoitu CSS-tietue: sen perusluokka sekä kaikki, mikä on johdettu CSS:stä + doc-kommenteista.

Ominaisuudet ​

name ​

name: string

Tietueen nimi @component/@utility/@rule/@declaration/@name -lähteestä, esim. button.

kind ​

kind: CssRecordKind

Minkälaista CSS-pintaa tämä dokumentoi (oletuksena component).

className ​

className: string

Perus-CSS-valitsin — luokka (.button), attribuutti ([data-layout="x"]), ID (#foo), tai shadow-DOM-pseudo (:host) — päätellään ensimmäisestä paljaasta luokka-säännöstä tai asetetaan nimenomaisesti @selector kautta. Aina ei-tyhjä (palaa .${name}-arvoon, jos päättely epäonnistuu).

summary? ​

optional summary?: string

Yhden rivin tiivistelmä @summary-kohdasta.

remarks? ​

optional remarks?: string

Laajempi proosakuvaus @remarks-kohdasta.

privateRemarks? ​

optional privateRemarks?: string

Ainoastaan sisäiseen käyttöön tarkoitettu proosa @privateRemarks-kohdasta (emitterit voivat valita olla sisällyttämättä sitä julkiseen outputiin).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Julkaisuvaihe modifier-lippu-tagista (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versio, jossa esiteltiin, @since-kohdasta.

group? ​

optional group?: string

Dokumentaatioryhmä/kategoria, @group/@category-kohdasta.

accessibility? ​

optional accessibility?: string

Saavutettavuusohjeistus, @a11y/@accessibility-kohdasta.

global? ​

optional global?: boolean

Asetetaan, kun tässä tietueessa on @global-tagi — sen modifierit (ja per-modifier @global-liput) koskevat mitä tahansa komponenttia/asettelua/sääntöä/deklarointia, eivät vain tämän tietueen perusluokkaa. Käytetään validoinnissa ja kulutustarkistuksissa modifier-osumien ratkaisemiseksi globaalisti.

modifiers ​

modifiers: CssModifier[]

AST:stä poimitut modifierit, joissa on merkintänä @modifier-proosaa kun sellainen on kirjoitettu.

parts ​

parts: CssPart[]

AST:stä poimitut ala-elementin osat (luokkaperusteiset), joissa on merkintänä @part-proosaa kun sellainen on kirjoitettu.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM:n julkistetut parts (::part(name)), @csspart-tai ::part()-valitsimesta.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Natiiviset pseudo-elementit, joihin komponentin tyylit vaikuttavat (::before, ::marker, …), peräisin @pseudo-tai valitsimesta.

states ​

states: CssState[]

Tilat, joihin komponentti reagoi, peräisin @cssstate, :state(), pseudo-luokat tai tilaluokat.

slots ​

slots: CssSlot[]

Nimetyt slotit, joita komponentin kuori paljastaa, @slot-kohdasta.

elements? ​

optional elements?: CssElementConstraints

Sallitut HTML-elementit @element-kohdasta (oletus + valinnaiset nimetyt profiilit).

todos ​

todos: string[]

Sisäiset tehtävämuistiinpanot, @todo-tageista ja /* @todo … */-rivikommenteista. Kehitysmuistiinpanoja, eivät julkinen API — emitterit voivat jättää ne pois (kuten CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design-tokenit, joita tämä komponentti kuluttaa: kaikki --*-custom propertyt, joihin viitataan var(...)-sisällä sen säännöissä, kukin merkintänä @tokens-proosaa missä kirjoitettu (ja mukaan lukien kaikki @tokens-julistetut tokenit, joita ei kirjaimellisesti löydy var()-haulla).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom propertyt, jotka tämä komponentti julistaa (@property) tai dokumentoi (@cssproperty).

functions ​

functions: CssFunction[]

CSS-kustomfunktiot (@function), jotka tämä komponentti määrittelee.

animations ​

animations: CssAnimation[]

Animaatiot (@keyframes), joita tämä komponentti paljastaa.

layers ​

layers: CssLayer[]

Cascade-layerit (@layer), joissa tämä komponentti on mukana.

conditions ​

conditions: CssCondition[]

Ehdollisen tuen lohkot (@container/@supports/@media), joiden alaisina säännöt ovat.

examples ​

examples: string[]

@example-lohkot, sanasta sanaan.

structure? ​

optional structure?: StructureNode[]

Kirjoitettu @structure elementtipuu (ylätason solmut), kun läsnä. Kun @structure-runko käyttää @variant-lohkoja (katso structureVariants), tämä sisältää vain ensimmäisen variantin solmut, taaksepäin yhteensopivuuden vuoksi koodille, jota ei ole päivitetty lukemaan structureVariants-kenttää.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Vaihtoehtoiset DOM-muodot tälle komponentille, kun kirjoitettu @structure-runko sisältää yhden tai useamman ylätason @variant-lohkon — puuttuu yleisestä tapauksesta, jossa on yksi ei-varianttirakenne.

structureDescription? ​

optional structureDescription?: string

Valinnainen proosaesittely, joka johtaa @structure-runkokappaletta, kun sellainen on kirjoitettu.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Komponenttikohtainen poistamisen korvausteksti, kun kirjoitettu (argumentti @deprecated-tagille).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Käyttöä koskeva proosa @usage-kohdasta — miten tyylitaulukko liitetään / komponenttia käytetään.

annotations ​

annotations: CssAnnotation[]

Paikallisen annotaation legenda-rivit @annotations-järjestyksessä, kirjoittajan järjestyksessä.

refs ​

refs: number[]

Paikallisen annotaation viitteet @ref-järjestyksessä, kirjoittajan järjestyksessä.

decorators ​

decorators: CssDecorator[]

Tietueen tasoiset objektimallin dekoroinnit.

compat ​

compat: string[]

Selain-tuesta / ominaisuuksien yhteensopivuusmuistiinpanot @compat-kohdasta.

related: CssRelated[]

Liittyvät komponentit @related-kohdasta.

memberOf? ​

optional memberOf?: CssMemberOf

Ilmoitettu jäsenyysperhe @memberOf-kohdasta — tämä tietue on toisen nimettyn tietueen jäsen, valinnaisesti private (saattaa esiintyä vain kyseisen vanhemman sisällä). Puuttuu, jos ei kirjoitettu.

members? ​

optional members?: string[]

Jäsen-tietueiden nimet @members-kohdasta — käänteissuunta, ilmoitettu vanhemmalla.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Rakenneistetut vanhemman puolen jäsenilmoitukset toistuvista @member-tageista.

source? ​

optional source?: CssSource

Missä tietue on kirjoitettu, kun sijaintitieto on saatavilla (lähde-linkkejä varten).

customBlocks? ​

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

Rekisteröityjen mukautettujen (lohko)tagejen sisältö, avain on tagin nimi ilman sen @. Täytetään vain konfiguraation kautta lisätyille tageille; rekisteröimättömät tuntemattomat tagit ohitetaan. Puuttuu, jos yhtään ei löydetty.