Interface: DocModifier
Defined in: packages/core/src/grammar.ts:87
The prose a @modifier tag contributes: a description and/or an inline deprecation replacement note.
Properties
affects?
optional affects?: object[];Defined in: packages/core/src/grammar.ts:108
Set from an inline @affects <component>.<target> marker — a descendant record this modifier changes the rendering of.
component
component: string;description?
optional description?: string;target
target: string;alias?
optional alias?: string;Defined in: packages/core/src/grammar.ts:100
Free-text alias guidance from an inline @alias tag on the modifier line.
aliasCanonical?
optional aliasCanonical?: string;Defined in: packages/core/src/grammar.ts:102
The canonical modifier this alias maps to, from @alias {@link -canonical} or @alias -canonical.
deprecated?
optional deprecated?: string;Defined in: packages/core/src/grammar.ts:92
Free-text replacement guidance from an inline deprecated tag on the modifier line.
deprecatedCanonical?
optional deprecatedCanonical?: string;Defined in: packages/core/src/grammar.ts:98
The canonical modifier this one deprecates, from a {@link -canonical} in the deprecation note (e.g. @deprecated {@link -color-danger}). Stored without its leading dot, matching the AST-derived deprecated.canonical, so an authored alias and a generated one resolve to the same reference.
deprecatedFlag?
optional deprecatedFlag?: boolean;Defined in: packages/core/src/grammar.ts:90
Set when the modifier carries a bare @deprecated (no note and no canonical link).
description?
optional description?: string;Defined in: packages/core/src/grammar.ts:88
global?
optional global?: boolean;Defined in: packages/core/src/grammar.ts:106
Set from an inline @global marker — this modifier applies to any component/layout/rule/declaration (not just its parent record).
interaction?
optional interaction?: boolean;Defined in: packages/core/src/grammar.ts:104
Set from an inline @interaction marker — a JS-toggled class with no CSS of its own.