pantoken / renderers/tinymce/src / CssDocEntry

Antaramuka: CssDocEntry ​

Satu rekod CSS yang didokumenkan: kelas asasnya serta segala yang diturunkan daripada CSS + komen dokumen.

Sifat ​

name ​

name: string

Nama rekod dari @component/@utility/@rule/@declaration/@name, contohnya button.

kind ​

kind: CssRecordKind

Jenis permukaan CSS yang didokumenkan (lalai kepada component).

className ​

className: string

Penyilih asas CSS — satu kelas (.button), atribut ([data-layout="x"]), ID (#foo), atau pseudo shadow-DOM (:host) — ditentukan daripada peraturan kelas kosong pertama atau ditetapkan secara eksplisit melalui @selector. Sentiasa tidak kosong (kembali kepada .${name} apabila inferens gagal).

summary? ​

optional summary?: string

Ringkasan satu baris dari @summary.

remarks? ​

optional remarks?: string

Prosa lanjutan dari @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prosa untuk kegunaan dalaman sahaja dari @privateRemarks (pemerbit boleh memilih untuk mengabaikannya dalam keluaran awam).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Tahap pelepasan dari tag bendera pengubah (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versi diperkenalkan, dari @since.

group? ​

optional group?: string

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

accessibility? ​

optional accessibility?: string

Panduan kebolehcapaian, dari @a11y/@accessibility.

global? ​

optional global?: boolean

Ditetapkan apabila rekod ini membawa tag @global — pengubahnya (dan bendera @global setiap-pengubah) berlaku kepada mana-mana komponen/tataletak/peraturan/deklarasi, bukan hanya kelas asas rekod ini. Digunakan semasa pengesahan dan semakan penggunaan untuk menyelesaikan padanan pengubah secara global.

modifiers ​

modifiers: CssModifier[]

Pengubah yang diekstrak dari AST, dihiasi dengan prosa @modifier apabila ditulis.

parts ​

parts: CssPart[]

Bahagian sub-elemen yang diekstrak dari AST (berasaskan kelas), dihiasi dengan prosa @part apabila ditulis.

shadowParts ​

shadowParts: CssPart[]

Bahagian yang didedahkan Shadow-DOM (::part(name)), dari @csspart atau penyilih ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elemen natif yang gaya komponen gunakan (::before, ::marker, …), dari @pseudo atau penyilih.

states ​

states: CssState[]

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

slots ​

slots: CssSlot[]

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

elements? ​

optional elements?: CssElementConstraints

Elemen HTML yang dibenarkan dari @element (lalai + profil bernama pilihan).

todos ​

todos: string[]

Nota to-do dalaman, dari tag @todo dan komen sebaris /* @todo … */. Nota pembangunan, bukan API awam — pemerbit boleh mengabaikannya (seperti CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Token reka bentuk yang komponen ini guna: setiap --* properti tersuai yang dirujuk melalui var(...) dalam peraturan, setiap satu dihiasi dengan prosa @tokens apabila ditulis (dan termasuk sebarang token yang diisytiharkan oleh @tokens yang tidak dijumpai secara literal melalui var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Properti tersuai yang komponen ini isytihar (@property) atau dokumenkan (@cssproperty).

functions ​

functions: CssFunction[]

Fungsi tersuai CSS (@function) yang komponen ini takrif.

animations ​

animations: CssAnimation[]

Animasi (@keyframes) yang komponen ini dedahkan.

layers ​

layers: CssLayer[]

Lapisan cascade (@layer) yang komponen ini sertai.

conditions ​

conditions: CssCondition[]

Blok sokongan bersyarat (@container/@supports/@media) yang peraturan berada di bawahnya.

examples ​

examples: string[]

Blok @example, secara literal.

structure? ​

optional structure?: StructureNode[]

Pokok elemen @structure yang ditulis (nod peringkat teratas), apabila wujud. Apabila badan @structure yang ditulis menggunakan blok @variant (lihat structureVariants), ini memegang nod varian pertama sahaja, untuk kebal-kod belakang dengan sebarang kod yang belum dikemas kini untuk membaca structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Bentuk DOM alternatif untuk komponen ini, apabila badan @structure yang ditulis mengandungi satu atau lebih blok @variant peringkat teratas — tiada untuk kes biasa struktur tunggal tanpa varian.

structureDescription? ​

optional structureDescription?: string

Satu penerangan prosa pilihan yang memimpin badan @structure, apabila ditulis.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Teks penggantian penyahgunaan pada peringkat komponen, apabila ditulis (argumen kepada tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa penggunaan dari @usage — cara memasukkan helaian gaya / menggunakan komponen.

annotations ​

annotations: CssAnnotation[]

Baris legenda anotasi tempatan dari @annotations, mengikut susunan pengarang.

refs ​

refs: number[]

Rujukan anotasi tempatan dari @ref, mengikut susunan pengarang.

decorators ​

decorators: CssDecorator[]

Pewarna model-objek pada peringkat rekod.

compat ​

compat: string[]

Nota sokongan penyemak imbas / keserasian ciri dari @compat.

related: CssRelated[]

Komponen berkaitan dari @related.

memberOf? ​

optional memberOf?: CssMemberOf

Keahlian keluarga yang diisytiharkan dari @memberOf — rekod ini adalah ahli rekod bernama lain, pilihan private (hanya boleh muncul di dalam induk itu). Tiada apabila tidak ditulis.

members? ​

optional members?: string[]

Nama rekod ahli dari @members — arah songsang, diisytiharkan pada induk.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Pernyataan ahli tersusun pada pihak induk dari tag @member yang diulang.

source? ​

optional source?: CssSource

Di mana rekod ditulis, apabila maklumat posisi tersedia (untuk pautan sumber).

customBlocks? ​

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

Isi bagi tag tersuai berdaftar (blok), diindeks mengikut nama tag tanpa @. Diisi hanya untuk tag yang ditambah melalui konfigurasi; tag yang tidak berdaftar dan tidak dikenali diabaikan. Tiada apabila tiada yang dijumpai.