---
url: /reference/@cssdoc/core/interfaces/DocModifier.md
---
# Interface: DocModifier

Defined in: [packages/core/src/grammar.ts:87](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L87)

The prose a `@modifier` tag contributes: a description and/or an inline deprecation replacement note.

## Properties

### affects?

```ts
optional affects?: object[];
```

Defined in: [packages/core/src/grammar.ts:108](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L108)

Set from an inline `@affects <component>.<target>` marker — a descendant record this modifier changes the rendering of.

#### component

```ts
component: string;
```

#### description?

```ts
optional description?: string;
```

#### target

```ts
target: string;
```

***

### alias?

```ts
optional alias?: string;
```

Defined in: [packages/core/src/grammar.ts:100](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L100)

Free-text alias guidance from an inline `@alias` tag on the modifier line.

***

### aliasCanonical?

```ts
optional aliasCanonical?: string;
```

Defined in: [packages/core/src/grammar.ts:102](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L102)

The canonical modifier this alias maps to, from `@alias {@link -canonical}` or `@alias -canonical`.

***

### deprecated?

```ts
optional deprecated?: string;
```

Defined in: [packages/core/src/grammar.ts:92](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L92)

Free-text replacement guidance from an inline `deprecated` tag on the modifier line.

***

### deprecatedCanonical?

```ts
optional deprecatedCanonical?: string;
```

Defined in: [packages/core/src/grammar.ts:98](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L98)

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?

```ts
optional deprecatedFlag?: boolean;
```

Defined in: [packages/core/src/grammar.ts:90](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L90)

Set when the modifier carries a bare `@deprecated` (no note and no canonical link).

***

### description?

```ts
optional description?: string;
```

Defined in: [packages/core/src/grammar.ts:88](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L88)

***

### global?

```ts
optional global?: boolean;
```

Defined in: [packages/core/src/grammar.ts:106](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L106)

Set from an inline `@global` marker — this modifier applies to any component/layout/rule/declaration (not just its parent record).

***

### interaction?

```ts
optional interaction?: boolean;
```

Defined in: [packages/core/src/grammar.ts:104](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/grammar.ts#L104)

Set from an inline `@interaction` marker — a JS-toggled class with no CSS of its own.