Interface: CssModifier

Defined in: packages/core/src/model.ts:16

A -<prop>-<value> (or boolean -<flag>) modifier on a component's base class.

Properties

deprecated?

optional deprecated?: object;

Defined in: packages/core/src/model.ts:30

Set when the modifier is deprecated. canonical (from an AST alias marker) is the modifier class to use instead; note (from an authored inline deprecation tag on the @modifier line) is free-text replacement guidance for cases where the replacement isn't itself a modifier.

canonical?

optional canonical?: string;

note?

optional note?: string;

---

description?

optional description?: string;

Defined in: packages/core/src/model.ts:24

Prose from a @modifier doc tag, when authored.

---

name

name: string;

Defined in: packages/core/src/model.ts:18

The modifier class without the leading dot, e.g. -color-secondary or -condensed.

---

prop

prop: string;

Defined in: packages/core/src/model.ts:20

The property segment, e.g. color (the text after the first -, up to the next -).

---

value?

optional value?: string;

Defined in: packages/core/src/model.ts:22

The value segment, e.g. secondary; absent for boolean modifiers.