Interface: CssDocEntry
Defined in: packages/core/src/model.ts:350
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:372
Accessibility guidance, from @a11y/@accessibility.
animations
animations: CssAnimation[];Defined in: packages/core/src/model.ts:409
Animations (@keyframes) this component exposes.
annotations
annotations: CssAnnotation[];Defined in: packages/core/src/model.ts:438
Local annotation legend rows from @annotations, in author order.
className
className: string;Defined in: packages/core/src/model.ts:358
The base CSS selector — a class (.button), attribute ([data-layout="x"]), ID (#foo), or shadow-DOM pseudo (:host) — inferred from the first bare-class rule or set explicitly via @selector. Always non-empty (falls back to .${name} when inference fails).
compat
compat: string[];Defined in: packages/core/src/model.ts:444
Browser-support / feature-compatibility notes from @compat.
conditions
conditions: CssCondition[];Defined in: packages/core/src/model.ts:413
Conditional-support blocks (@container/@supports/@media) the rules sit under.
cssPropertiesConsumed
cssPropertiesConsumed: CssTokenConsumed[];Defined in: packages/core/src/model.ts:403
Design tokens this component consumes: every --* custom property referenced via var(...) inside its rules, each annotated with @tokens prose where authored (and including any @tokens-declared token not literally found via var()).
cssPropertiesDeclared
cssPropertiesDeclared: CssPropertyDeclared[];Defined in: packages/core/src/model.ts:405
Custom properties this component declares (@property) or documents (@cssproperty).
customBlocks?
optional customBlocks?: Record<string, string[]>;Defined in: packages/core/src/model.ts:462
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.
decorators
decorators: CssDecorator[];Defined in: packages/core/src/model.ts:442
Record-level object-model decorators.
demo?
optional demo?: string;Defined in: packages/core/src/model.ts:430
@demo <spec> (e.g. self:button), when authored.
deprecated?
optional deprecated?: string;Defined in: packages/core/src/model.ts:432
Component-level deprecation replacement text, when authored (the argument to a @deprecated tag).
elements?
optional elements?: CssElementConstraints;Defined in: packages/core/src/model.ts:392
Allowed HTML elements from @element (default + optional named profiles).
examples
examples: string[];Defined in: packages/core/src/model.ts:415
@example blocks, verbatim.
functions
functions: CssFunction[];Defined in: packages/core/src/model.ts:407
CSS custom functions (@function) this component defines.
global?
optional global?: boolean;Defined in: packages/core/src/model.ts:378
Set when this record carries a @global tag — its modifiers (and per-modifier @global flags) apply to any component/layout/rule/declaration, not just this record's base class. Used during validation and consumption checks to resolve modifier matches globally.
group?
optional group?: string;Defined in: packages/core/src/model.ts:370
A documentation group/category, from @group/@category.
kind
kind: CssRecordKind;Defined in: packages/core/src/model.ts:354
Which kind of CSS surface this documents (defaults to component).
layers
layers: CssLayer[];Defined in: packages/core/src/model.ts:411
Cascade layers (@layer) this component participates in.
memberDeclarations?
optional memberDeclarations?: CssMemberDeclaration[];Defined in: packages/core/src/model.ts:455
Structured parent-side member declarations from repeated @member tags.
memberOf?
optional memberOf?: CssMemberOf;Defined in: packages/core/src/model.ts:451
Declared family membership from @memberOf — this record is a member of another named record, optionally private (must only ever appear inside that parent). Absent when not authored.
members?
optional members?: string[];Defined in: packages/core/src/model.ts:453
Member record names from @members — the inverse direction, declared on the parent.
modifiers
modifiers: CssModifier[];Defined in: packages/core/src/model.ts:380
AST-extracted modifiers, annotated with @modifier prose where authored.
name
name: string;Defined in: packages/core/src/model.ts:352
The record name from @component/@utility/@rule/@declaration/@name, e.g. button.
parts
parts: CssPart[];Defined in: packages/core/src/model.ts:382
AST-extracted sub-element parts (class-based), annotated with @part prose where authored.
privateRemarks?
optional privateRemarks?: string;Defined in: packages/core/src/model.ts:364
Internal-only prose from @privateRemarks (emitters may choose to omit it from public output).
pseudoElements
pseudoElements: CssPseudoElement[];Defined in: packages/core/src/model.ts:386
Native pseudo-elements the component styles (::before, ::marker, …), from @pseudo or a selector.
refs
refs: number[];Defined in: packages/core/src/model.ts:440
Local annotation references from @ref, in author order.
related
related: CssRelated[];Defined in: packages/core/src/model.ts:446
Related components from @related.
releaseStage?
optional releaseStage?: CssReleaseStage;Defined in: packages/core/src/model.ts:366
The release stage from a modifier flag tag (@alpha/@beta/@experimental/@internal/@public).
remarks?
optional remarks?: string;Defined in: packages/core/src/model.ts:362
Extended prose from @remarks.
see
see: string[];Defined in: packages/core/src/model.ts:434
@see <ref> cross-references.
shadowParts
shadowParts: CssPart[];Defined in: packages/core/src/model.ts:384
Shadow-DOM exposed parts (::part(name)), from @csspart or a ::part() selector.
since?
optional since?: string;Defined in: packages/core/src/model.ts:368
Version introduced, from @since.
slots
slots: CssSlot[];Defined in: packages/core/src/model.ts:390
Named slots the component shell exposes, from @slot.
source?
optional source?: CssSource;Defined in: packages/core/src/model.ts:457
Where the record was authored, when position info is available (for source links).
states
states: CssState[];Defined in: packages/core/src/model.ts:388
States the component reacts to, from @cssstate, :state(), pseudo-classes, or state classes.
structure?
optional structure?: StructureNode[];Defined in: packages/core/src/model.ts:421
The authored @structure element tree (top-level nodes), when present. When the @structure body uses @variant blocks (see structureVariants), this holds the first variant's nodes only, for back-compat with any code that hasn't been updated to read structureVariants.
structureDescription?
optional structureDescription?: string;Defined in: packages/core/src/model.ts:428
An optional prose description leading the @structure body, when authored.
structureVariants?
optional structureVariants?: StructureVariant[];Defined in: packages/core/src/model.ts:426
Alternative DOM shapes for this component, when the authored @structure body contains one or more top-level @variant blocks — absent for the common case of a single, non-variant structure.
summary?
optional summary?: string;Defined in: packages/core/src/model.ts:360
One-line summary from @summary.
todos
todos: string[];Defined in: packages/core/src/model.ts:397
Internal to-do notes, from @todo tags and /* @todo … */ inline comments. Development notes, not public API — emitters may omit them (like CssDocEntry.privateRemarks).
usage?
optional usage?: string;Defined in: packages/core/src/model.ts:436
Usage prose from @usage — how to include the stylesheet / use the component.