Skip to content

Interface: CssDocTagDefinitionOptions

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

Options for constructing a CssDocTagDefinition.

Properties

aliasFor?

ts
optional aliasFor?: string;

Defined in: packages/core/src/configuration.ts:34

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:30

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


recordKind?

ts
optional recordKind?: CssRecordKind;

Defined in: packages/core/src/configuration.ts:32

For record tags, the CssRecordKind the tag selects.


syntaxKind

ts
syntaxKind: CssDocSyntaxKind;

Defined in: packages/core/src/configuration.ts:28

The tag's syntactic kind.


tagName

ts
tagName: string;

Defined in: packages/core/src/configuration.ts:26

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

Released under the MIT License