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

Defined in: [packages/core/src/configuration.ts:31](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L31)

Options for constructing a [CssDocTagDefinition](../classes/CssDocTagDefinition.md).

## Properties

### aliasFor?

```ts
optional aliasFor?: string;
```

Defined in: [packages/core/src/configuration.ts:41](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L41)

The canonical tag (without `@`) this tag is an alias of, e.g. `@csspart` aliases `part`.

***

### allowMultiple?

```ts
optional allowMultiple?: boolean;
```

Defined in: [packages/core/src/configuration.ts:37](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L37)

Whether the tag may appear more than once in a comment (defaults to `false`).

***

### description?

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

Defined in: [packages/core/src/configuration.ts:43](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L43)

A one-line description of the tag's purpose, surfaced in editor completions/hover.

***

### recordKind?

```ts
optional recordKind?: CssRecordKind;
```

Defined in: [packages/core/src/configuration.ts:39](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L39)

For `record` tags, the [CssRecordKind](../type-aliases/CssRecordKind.md) the tag selects.

***

### syntaxKind

```ts
syntaxKind: CssDocSyntaxKind;
```

Defined in: [packages/core/src/configuration.ts:35](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L35)

The tag's syntactic kind.

***

### tagName

```ts
tagName: string;
```

Defined in: [packages/core/src/configuration.ts:33](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L33)

The tag name, with or without a leading `@` (e.g. `@modifier` or `modifier`).
