pantoken / renderers/tinymce/src / CssDocEntry

Interfejs: CssDocEntry ​

Jeden udokumentowany rekord CSS: jego klasa bazowa oraz wszystko pochodne z CSS + komentarzy dokumentacyjnych.

Właściwości ​

name ​

name: string

Nazwa rekordu z @component/@utility/@rule/@declaration/@name, np. button.

kind ​

kind: CssRecordKind

Jakiego rodzaju powierzchnia CSS jest dokumentowana (domyślnie component).

className ​

className: string

Podstawowy selektor CSS — klasa (.button), atrybut ([data-layout="x"]), ID (#foo), lub pseudo shadow-DOM (:host) — wywnioskowany z pierwszej reguły z gołą klasą lub ustawiony jawnie przez @selector. Zawsze niepusty (wraca do .${name} gdy wnioskowanie się nie powiedzie).

summary? ​

optional summary?: string

Jednolinijkowe streszczenie z @summary.

remarks? ​

optional remarks?: string

Rozszerzona proza z @remarks.

privateRemarks? ​

optional privateRemarks?: string

Proza tylko wewnętrzna z @privateRemarks (emiterzy mogą pominąć ją w publicznym wydruku).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Etap wydania z tagu flagi modyfikatora (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Wersja, w której wprowadzono, z @since.

group? ​

optional group?: string

Grupa/kategoria dokumentacji, z @group/@category.

accessibility? ​

optional accessibility?: string

Wytyczne dostępności, z @a11y/@accessibility.

global? ​

optional global?: boolean

Ustawione gdy rekord posiada tag @global — jego modyfikatory (i per-modyfikatorowe flagi @global) stosują się do dowolnego komponentu/układu/reguły/deklaracji, nie tylko do klasy bazowej tego rekordu. Używane podczas walidacji i kontroli konsumpcji do rozwiązywania dopasowań modyfikatorów globalnie.

modifiers ​

modifiers: CssModifier[]

Modyfikatory wyekstrahowane z AST, opatrzone prozą @modifier tam gdzie autor ją dodał.

parts ​

parts: CssPart[]

Części pod-elementów wyekstrahowane z AST (oparte na klasach), opatrzone prozą @part tam gdzie autor ją dodał.

shadowParts ​

shadowParts: CssPart[]

Eksponowane części Shadow-DOM (::part(name)), z @csspart lub selektora ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Natywne pseudo-elementy, które styluje komponent (::before, ::marker, …), z @pseudo lub selektora.

states ​

states: CssState[]

Stany, na które komponent reaguje, z @cssstate, :state(), pseudo-klasami lub klasami stanów.

slots ​

slots: CssSlot[]

Nazwane sloty, które eksponuje powłoka komponentu, z @slot.

elements? ​

optional elements?: CssElementConstraints

Dozwolone elementy HTML z @element (domyślne + opcjonalne profile nazwane).

todos ​

todos: string[]

We własne notatki do zrobienia, z tagów @todo i komentarzy inline /* @todo … */. Notatki deweloperskie, nie publiczne API — emiterzy mogą je pominąć (jak CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokeny projektowe, których używa ten komponent: każda niestandardowa właściwość --* odwołana przez var(...) wewnątrz jego reguł, każda opatrzona prozą @tokens tam gdzie autor ją dodał (i włączając każdy token zadeklarowany przez @tokens, który nie został dosłownie znaleziony przez var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Niestandardowe właściwości, które ten komponent deklaruje (@property) lub dokumentuje (@cssproperty).

functions ​

functions: CssFunction[]

Funkcje niestandardowe CSS (@function), które definiuje ten komponent.

animations ​

animations: CssAnimation[]

Animacje (@keyframes), które eksponuje ten komponent.

layers ​

layers: CssLayer[]

Warstwy kaskady (@layer), w których uczestniczy ten komponent.

conditions ​

conditions: CssCondition[]

Bloki warunkowego wsparcia (@container/@supports/@media), pod którymi znajdują się reguły.

examples ​

examples: string[]

Bloki @example, dosłownie.

structure? ​

optional structure?: StructureNode[]

Autorski drzewo elementów @structure (węzły najwyższego poziomu), gdy obecne. Gdy ciało @structure używa bloków @variant (patrz structureVariants), to zawiera tylko węzły pierwszego wariantu, dla kompatybilności wstecznej z kodem, który nie został zaktualizowany do czytania structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Alternatywne kształty DOM dla tego komponentu, gdy autorskie ciało @structure zawiera jeden lub więcej top-level bloków @variant — nieobecne w powszechnym przypadku pojedynczej, niewariantowej struktury.

structureDescription? ​

optional structureDescription?: string

Opcjonalny opis prozą poprzedzający ciało @structure, jeśli autor go dodał.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Tekst zastępczy deprecacji na poziomie komponentu, jeśli autor dodał (argument do tagu @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Proza użycia z @usage — jak dołączyć arkusz stylów / używać komponentu.

annotations ​

annotations: CssAnnotation[]

Wiersze legendy adnotacji lokalnych z @annotations, w porządku autorów.

refs ​

refs: number[]

Odwołania adnotacji lokalnych z @ref, w porządku autorów.

decorators ​

decorators: CssDecorator[]

Dekoratory modelu obiektowego na poziomie rekordu.

compat ​

compat: string[]

Uwaga dotycząca wsparcia przeglądarek / zgodności funkcji z @compat.

related: CssRelated[]

Powiązane komponenty z @related.

memberOf? ​

optional memberOf?: CssMemberOf

Deklarowane członkostwo w rodzinie z @memberOf — ten rekord jest członkiem innego nazwanego rekordu, opcjonalnie private (musi pojawiać się tylko wewnątrz tego rodzica). Nieobecne gdy nieautorskie.

members? ​

optional members?: string[]

Nazwy rekordów członków z @members — kierunek odwrotny, zadeklarowany na rodzicu.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Strukturalne deklaracje członków po stronie rodzica z powtarzających się tagów @member.

source? ​

optional source?: CssSource

Gdzie rekord został autorowany, gdy dostępne są informacje o położeniu (do linków źródłowych).

customBlocks? ​

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

Zawartość zarejestrowanych niestandardowych tagów (blokowych), kluczowana według nazwy taga bez jego @. Wypełniana tylko dla tagów dodanych poprzez konfigurację; niezarejestrowane, nieznane tagi są ignorowane. Nieobecne, gdy żadne nie zostały znalezione.