Interface: CssDocEntry
Defined in: packages/core/src/model.ts:137
One documented CSS record: its base class plus everything derived from the CSS + doc comments.
Properties
accessibility?
optional accessibility?: string;Defined in: packages/core/src/model.ts:157
Accessibility guidance, from @a11y/@accessibility.
animations
animations: CssAnimation[];Defined in: packages/core/src/model.ts:173
Animations (@keyframes) this component exposes.
className
className: string;Defined in: packages/core/src/model.ts:143
The base class selector, e.g. .button (inferred from the first bare-class rule).
conditions
conditions: CssCondition[];Defined in: packages/core/src/model.ts:177
Conditional-support blocks (@container/@supports/@media) the rules sit under.
cssPropertiesConsumed
cssPropertiesConsumed: string[];Defined in: packages/core/src/model.ts:167
Every --* custom property referenced via var(...) inside this component's rules.
cssPropertiesDeclared
cssPropertiesDeclared: CssPropertyDeclared[];Defined in: packages/core/src/model.ts:169
Custom properties this component declares (@property) or documents (@cssproperty).
customBlocks?
optional customBlocks?: Record<string, string[]>;Defined in: packages/core/src/model.ts:192
Content of registered custom (block) tags, keyed by tag name without its @. Populated only for tags added via configuration; unregistered unknown tags are ignored. Absent when none were found.
demo?
optional demo?: string;Defined in: packages/core/src/model.ts:183
@demo <spec> (e.g. self:button), when authored.
deprecated?
optional deprecated?: string;Defined in: packages/core/src/model.ts:185
Component-level deprecation replacement text, when authored (the argument to a @deprecated tag).
examples
examples: string[];Defined in: packages/core/src/model.ts:179
@example blocks, verbatim.
functions
functions: CssFunction[];Defined in: packages/core/src/model.ts:171
CSS custom functions (@function) this component defines.
group?
optional group?: string;Defined in: packages/core/src/model.ts:155
A documentation group/category, from @group/@category.
kind
kind: CssRecordKind;Defined in: packages/core/src/model.ts:141
Which kind of CSS surface this documents (defaults to component).
layers
layers: CssLayer[];Defined in: packages/core/src/model.ts:175
Cascade layers (@layer) this component participates in.
modifiers
modifiers: CssModifier[];Defined in: packages/core/src/model.ts:159
AST-extracted modifiers, annotated with @modifier prose where authored.
name
name: string;Defined in: packages/core/src/model.ts:139
The record name from @component/@utility/@rule/@declaration/@name, e.g. button.
parts
parts: CssPart[];Defined in: packages/core/src/model.ts:161
AST-extracted sub-element parts, annotated with @part/@csspart prose where authored.
privateRemarks?
optional privateRemarks?: string;Defined in: packages/core/src/model.ts:149
Internal-only prose from @privateRemarks (emitters may choose to omit it from public output).
releaseStage?
optional releaseStage?: CssReleaseStage;Defined in: packages/core/src/model.ts:151
The release stage from a modifier flag tag (@alpha/@beta/@experimental/@internal/@public).
remarks?
optional remarks?: string;Defined in: packages/core/src/model.ts:147
Extended prose from @remarks.
see
see: string[];Defined in: packages/core/src/model.ts:187
@see <ref> cross-references.
since?
optional since?: string;Defined in: packages/core/src/model.ts:153
Version introduced, from @since.
slots
slots: CssSlot[];Defined in: packages/core/src/model.ts:165
Named slots the component shell exposes, from @slot.
states
states: CssState[];Defined in: packages/core/src/model.ts:163
States the component reacts to, from @cssstate.
structure?
optional structure?: StructureNode[];Defined in: packages/core/src/model.ts:181
The authored @structure HTML tree (top-level nodes), when present.
summary?
optional summary?: string;Defined in: packages/core/src/model.ts:145
One-line summary from @summary.