Skip to content

pantoken / renderers/tinymce/src / CssDocEntry

インターフェース: CssDocEntry

1つの文書化された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)、 またはシャドウ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[]

シャドウ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

@element からの許可されたHTML要素(デフォルト+オプションの名前付きプロファイル)。


todos

todos: string[]

@todo タグと /* @todo … */ インラインコメントからの内部用To‑doノート。開発メモであり公開APIではない—エミッタは省略する場合がある(CssDocEntry.privateRemarks のように)。


cssPropertiesConsumed

cssPropertiesConsumed: CssTokenConsumed[]

このコンポーネントが消費するデザイントークン:そのルール内で var(...) を介して参照されるすべての --* カスタムプロパティ、各々は作成時に @tokens の本文で注釈されている(および var() を介して文字通り見つからなかった @tokens 宣言トークンも含む)。


cssPropertiesDeclared

cssPropertiesDeclared: CssPropertyDeclared[]

このコンポーネントが宣言する(@property)または文書化する(@cssproperty)カスタムプロパティ。


functions

functions: CssFunction[]

このコンポーネントが定義するCSSカスタム関数(@function)。


animations

animations: CssAnimation[]

このコンポーネントが公開するアニメーション(@keyframes)。


layers

layers: CssLayer[]

このコンポーネントが参加するカスケードレイヤー(@layer)。


conditions

conditions: CssCondition[]

ルールが属する条件付きサポートブロック(@container/@supports/@media)。


examples

examples: string[]

@example ブロックをそのまま(逐語)。


structure?

optional structure?: StructureNode[]

作成された @structure の要素ツリー(トップレベルノード)、存在する場合。@structure 本文が @variant ブロックを使用する場合(structureVariants を参照)、これは最初のバリアントのノードのみを保持し、structureVariants を読むように更新されていないコードとの互換性を保つ。


structureVariants?

optional structureVariants?: StructureVariant[]

作成された @structure 本文に1つ以上のトップレベル @variant ブロックが含まれる場合の代替DOM形状—単一の非バリアント構造が一般的な場合は存在しない。


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[]

レコードレベルのオブジェクトモデルデコレータ。


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[]>

登録されたカスタム(ブロック)タグの内容。タグ名は@を除いた形でキー化されます。設定経由で追加されたタグのみで埋められ、登録されていない未知のタグは無視されます。見つからなかった場合は存在しません。