pantoken / renderers/tinymce/src / CssDocEntry

Antarmuka: CssDocEntry ​

Satu record CSS terdokumentasi: kelas dasar dan semua yang diturunkan dari CSS + komentar dokumentasi.

Properti ​

name ​

name: string

Nama record dari @component/@utility/@rule/@declaration/@name, mis. button.

kind ​

kind: CssRecordKind

Jenis permukaan CSS yang didokumentasikan ini (default ke component).

className ​

className: string

Selektor CSS dasar — sebuah kelas (.button), atribut ([data-layout="x"]), ID (#foo), atau pseudo shadow-DOM (:host) — diinfer dari aturan bare-class pertama atau disetel secara eksplisit via @selector. Selalu tidak kosong (menggunakan .${name} saat inferensi gagal).

summary? ​

optional summary?: string

Ringkasan satu baris dari @summary.

remarks? ​

optional remarks?: string

Prosa terperinci dari @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prosa hanya-internal dari @privateRemarks (emitter dapat memilih untuk tidak menyertakannya dalam output publik).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Tahap rilis dari tag flag modifier (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versi diperkenalkan, dari @since.

group? ​

optional group?: string

Grup/kategori dokumentasi, dari @group/@category.

accessibility? ​

optional accessibility?: string

Panduan aksesibilitas, dari @a11y/@accessibility.

global? ​

optional global?: boolean

Disetel ketika record ini membawa tag @global — modifiernya (dan per-modifier flag @global) berlaku untuk komponen/layanan/aturan/deklarasi apa pun, bukan hanya kelas dasar record ini. Digunakan saat validasi dan pemeriksaan konsumsi untuk menyelesaikan pencocokan modifier secara global.

modifiers ​

modifiers: CssModifier[]

Modifier yang diekstrak dari AST, diberi anotasi prosa @modifier jika ditulis.

parts ​

parts: CssPart[]

Bagian sub-elemen yang diekstrak dari AST (berbasis kelas), diberi anotasi prosa @part jika ditulis.

shadowParts ​

shadowParts: CssPart[]

Parts yang diekspos di Shadow-DOM (::part(name)), dari @csspart atau selektor ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elemen native yang distyling oleh komponen (::before, ::marker, …), dari @pseudo atau selektor.

states ​

states: CssState[]

Status yang direspon komponen, dari @cssstate, :state(), pseudo-class, atau kelas status.

slots ​

slots: CssSlot[]

Slot bernama yang diekspos oleh shell komponen, dari @slot.

elements? ​

optional elements?: CssElementConstraints

Elemen HTML yang diperbolehkan dari @element (default + profil bernama opsional).

todos ​

todos: string[]

Catatan to-do internal, dari tag @todo dan komentar inline /* @todo … */. Catatan pengembangan, bukan API publik — emitter dapat menghilangkannya (seperti CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Token desain yang dikonsumsi komponen ini: setiap properti kustom --* yang dirujuk via var(...) di dalam aturannya, masing‑masing dianotasi dengan prosa @tokens jika ditulis (dan termasuk token yang dideklarasikan @tokens yang tidak ditemukan secara literal via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Properti kustom yang dideklarasikan (@property) atau didokumentasikan (@cssproperty) oleh komponen ini.

functions ​

functions: CssFunction[]

Fungsi kustom CSS (@function) yang didefinisikan komponen ini.

animations ​

animations: CssAnimation[]

Animasi (@keyframes) yang diekspos komponen ini.

layers ​

layers: CssLayer[]

Lapis cascade (@layer) yang diikuti komponen ini.

conditions ​

conditions: CssCondition[]

Blok dukungan kondisional (@container/@supports/@media) tempat aturan berada.

examples ​

examples: string[]

Blok @example, verbatim.

structure? ​

optional structure?: StructureNode[]

Pohon elemen @structure yang ditulis (node tingkat atas), bila ada. Saat badan @structure yang ditulis menggunakan blok @variant (lihat structureVariants), ini memuat node varian pertama saja, untuk kompatibilitas mundur dengan kode yang belum diperbarui untuk membaca structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Bentuk DOM alternatif untuk komponen ini, ketika badan @structure yang ditulis berisi satu atau lebih blok @variant tingkat atas — tidak ada untuk kasus umum struktur tunggal tanpa varian.

structureDescription? ​

optional structureDescription?: string

Deskripsi prosa opsional yang memimpin badan @structure, bila ditulis.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Teks pengganti deprecation pada level komponen, jika ditulis (argumen untuk tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa penggunaan dari @usage — cara menyertakan stylesheet / menggunakan komponen.

annotations ​

annotations: CssAnnotation[]

Baris legenda anotasi lokal dari @annotations, dalam urutan penulis.

refs ​

refs: number[]

Referensi anotasi lokal dari @ref, dalam urutan penulis.

decorators ​

decorators: CssDecorator[]

Dekorator model-objek pada level record.

compat ​

compat: string[]

Catatan dukungan browser / kompatibilitas fitur dari @compat.

related: CssRelated[]

Komponen terkait dari @related.

memberOf? ​

optional memberOf?: CssMemberOf

Keanggotaan family yang dideklarasikan dari @memberOf — record ini adalah anggota record bernama lain, opsional private (hanya boleh muncul di dalam parent itu). Tidak ada jika tidak ditulis.

members? ​

optional members?: string[]

Nama record anggota dari @members — arah invers, dideklarasikan pada parent.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Deklarasi anggota terstruktur sisi-parent dari tag @member yang diulang.

source? ​

optional source?: CssSource

Di mana record ditulis, bila info posisi tersedia (untuk tautan sumber).

customBlocks? ​

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

Konten tag kustom terdaftar (blok), diindeks berdasarkan nama tag tanpa @. Diisi hanya untuk tags yang ditambahkan melalui konfigurasi; tag yang tidak terdaftar diabaikan. Tidak ada bila tidak ditemukan.