Interface: CssDocTagDefinitionOptions

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

Options for constructing a CssDocTagDefinition.

Properties

aliasFor?

optional aliasFor?: string;

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

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

---

allowMultiple?

optional allowMultiple?: boolean;

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

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

---

description?

optional description?: string;

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

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

---

recordKind?

optional recordKind?: CssRecordKind;

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

For record tags, the CssRecordKind the tag selects.

---

syntaxKind

syntaxKind: CssDocSyntaxKind;

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

The tag's syntactic kind.

---

tagName

tagName: string;

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

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