pantoken / renderers/tinymce/src / CssDocEntry

介面: CssDocEntry ​

一個記錄化的 CSS 條目：其基礎類別以及從該 CSS 與文件註解衍生出的所有內容。

屬性 ​

name ​

name: string

從 @component/@utility/@rule/@declaration/@name 取得的記錄名稱，例如 button。

kind ​

kind: CssRecordKind

此文件所記錄的 CSS 類型（預設為 component）。

className ​

className: string

基礎 CSS 選擇器 — 一個類別（.button）、屬性（[data-layout="x"]）、ID（#foo） 或 shadow-DOM 偽元素（:host）— 從第一個裸類別規則推斷，或透過 @selector 明確設定。始終非空（當推斷失敗時回退為 .${name}）。

summary? ​

optional summary?: string

來自 @summary 的一行摘要。

remarks? ​

optional remarks?: string

來自 @remarks 的擴展敘述文字（長文）。

privateRemarks? ​

optional privateRemarks?: string

來自 @privateRemarks 的僅供內部使用的敘述（發行器可選擇從公開輸出中省略）。

releaseStage? ​

optional releaseStage?: CssReleaseStage

來自修飾標籤旗標的發行階段（@alpha/@beta/@experimental/@internal/@public）。

since? ​

optional since?: string

引入版本，來自 @since。

group? ​

optional group?: string

文件群組/類別，來自 @group/@category。

accessibility? ​

optional accessibility?: string

無障礙指引，來自 @a11y/@accessibility。

global? ​

optional global?: boolean

當此記錄帶有 @global 標籤時設定 — 其修飾子（以及每修飾子的 @global 旗標） 適用於任何元件/版面/規則/宣告，而不僅限於此記錄的基礎類別。用於驗證與消費檢查以全局解析修飾子匹配。

modifiers ​

modifiers: CssModifier[]

由 AST 擷取的修飾子，並在作者撰寫時以 @modifier 敘述註記。

parts ​

parts: CssPart[]

由 AST 擷取的子元素部件（基於類別），並在作者撰寫時以 @part 敘述註記。

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM 可暴露的 parts（::part(name)），來自 @csspart 或 ::part() 選擇器。

pseudoElements ​

pseudoElements: CssPseudoElement[]

元件樣式的原生偽元素（::before, ::marker, …），來自 @pseudo 或一個選擇器。

states ​

states: CssState[]

元件會回應的狀態，來自 @cssstate, :state(), 偽類或狀態類別。

slots ​

slots: CssSlot[]

元件殼體暴露的命名插槽，來自 @slot。

elements? ​

optional elements?: CssElementConstraints

允許的 HTML 元素，來自 @element（預設 + 可選命名配置）。

todos ​

todos: string[]

內部待辦註記，來自 @todo 標籤與 /* @todo … */ 行內註解。為開發註記，非公開 API — 發行器可省略（如 CssDocEntry.privateRemarks）。

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

此元件使用的設計代幣：透過 var(...) 在其規則中被引用的所有 --* 自訂屬性，並在作者撰寫時以 @tokens 敘述註記（且包含任何由 @tokens 宣告但未透過 var() 字面找到的代幣）。

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

此元件宣告（@property）或記錄（@cssproperty）的自訂屬性。

functions ​

functions: CssFunction[]

此元件定義的 CSS 自訂函式（@function）。

animations ​

animations: CssAnimation[]

此元件公開的動畫（@keyframes）。

layers ​

layers: CssLayer[]

此元件參與的 cascade 層（@layer）。

conditions ​

conditions: CssCondition[]

規則所屬的條件支援區塊（@container/@supports/@media）。

examples ​

examples: string[]

@example 區塊，逐字。

structure? ​

optional structure?: StructureNode[]

已撰寫的 @structure 元素樹（頂層節點），若存在。當 @structure 主體使用 @variant 區塊（見 structureVariants）時，僅保留第一個變體的節點，為了與尚未更新以讀取 structureVariants 的程式碼相容。

structureVariants? ​

optional structureVariants?: StructureVariant[]

此元件的替代 DOM 形狀，當已撰寫的 @structure 主體包含一個或多個頂層 @variant 區塊時存在 — 若為單一且無變體的結構則不存在。

structureDescription? ​

optional structureDescription?: string

在已撰寫時，作為 @structure 主體前導的可選敘述文字。

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

元件層級的棄用替代文字，若已撰寫（作為 @deprecated 標籤的參數）。

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

來自 @usage 的使用說明文字 — 如何包含樣式表 / 使用該元件。

annotations ​

annotations: CssAnnotation[]

來自 @annotations 的本地註解圖例列，按作者順序排列。

refs ​

refs: number[]

來自 @ref 的本地註解引用，按作者順序排列。

decorators ​

decorators: CssDecorator[]

記錄層級的物件模型裝飾器（decorators）。

compat ​

compat: string[]

來自 @compat 的瀏覽器支援 / 功能相容性註記。

related: CssRelated[]

來自 @related 的相關元件。

memberOf? ​

optional memberOf?: CssMemberOf

來自 @memberOf 的宣告成員關係 — 此記錄為另一命名記錄的成員， 可選地為 private（僅可出現在該父項內）。未撰寫時不存在。

members? ​

optional members?: string[]

來自 @members 的成員記錄名稱 — 反向方向，在父項上宣告。

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

來自重複 @member 標籤的結構化父側成員宣告。

source? ​

optional source?: CssSource

記錄被撰寫的位置，當位置資訊可用時（用於來源連結）。

customBlocks? ​

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

已登記的自訂（區塊）標籤的內容，鍵為標籤名稱但不含其 @。僅對透過設定新增的 標籤進行填充；未註冊的未知標籤會被忽略。若未找到則不會出現。