--- url: /reference/@cssdoc/core/classes/CssDocConfiguration.md --- # Class: CssDocConfiguration Defined in: [packages/core/src/configuration.ts:106](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L106) ## Constructors ### Constructor ```ts new CssDocConfiguration(): CssDocConfiguration; ``` Defined in: [packages/core/src/configuration.ts:114](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L114) #### Returns `CssDocConfiguration` ## Properties ### standardTagNames ```ts readonly static standardTagNames: readonly string[] = CSSDOC_TAG_NAMES; ``` Defined in: [packages/core/src/configuration.ts:213](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L213) The names (without `@`) of every standard tag — the canonical vocabulary from `@cssdoc/spec`. ## Accessors ### globalPrecedence #### Get Signature ```ts get globalPrecedence(): "base" | "global"; ``` Defined in: [packages/core/src/configuration.ts:142](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L142) Precedence when a base record and a `@global` record both define the same modifier name: `"base"` (explicit modifiers win; default) or `"global"` (the global one wins). ##### Returns `"base"` | `"global"` *** ### inlineComments #### Get Signature ```ts get inlineComments(): InlineCommentMode; ``` Defined in: [packages/core/src/configuration.ts:129](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L129) How inline `/* … */` comments combine with tag prose (defaults to `append`). ##### Returns [`InlineCommentMode`](../type-aliases/InlineCommentMode.md) *** ### modifierConvention #### Get Signature ```ts get modifierConvention(): ModifierConvention; ``` Defined in: [packages/core/src/configuration.ts:119](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L119) The resolved modifier convention this configuration parses with (defaults to BEM). ##### Returns [`ModifierConvention`](../interfaces/ModifierConvention.md) *** ### supportedTagDefinitions #### Get Signature ```ts get supportedTagDefinitions(): readonly CssDocTagDefinition[]; ``` Defined in: [packages/core/src/configuration.ts:157](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L157) Only the tag definitions that are currently supported. ##### Returns readonly [`CssDocTagDefinition`](CssDocTagDefinition.md)\[] *** ### tagDefinitions #### Get Signature ```ts get tagDefinitions(): readonly CssDocTagDefinition[]; ``` Defined in: [packages/core/src/configuration.ts:152](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L152) Every registered tag definition, in registration order. ##### Returns readonly [`CssDocTagDefinition`](CssDocTagDefinition.md)\[] ## Methods ### addTagDefinition() ```ts addTagDefinition(definition, supported?): void; ``` Defined in: [packages/core/src/configuration.ts:167](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L167) Register a tag definition. Re-registering a tag name replaces the earlier definition. #### Parameters ##### definition [`CssDocTagDefinition`](CssDocTagDefinition.md) The tag to add. ##### supported? `boolean` = `true` Whether it is supported (defaults to `true`). #### Returns `void` *** ### addTagDefinitions() ```ts addTagDefinitions(definitions, supported?): void; ``` Defined in: [packages/core/src/configuration.ts:179](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L179) Register several tag definitions. #### Parameters ##### definitions readonly [`CssDocTagDefinition`](CssDocTagDefinition.md)\[] ##### supported? `boolean` = `true` #### Returns `void` *** ### isTagSupported() ```ts isTagSupported(definition): boolean; ``` Defined in: [packages/core/src/configuration.ts:189](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L189) Whether a tag definition is supported. #### Parameters ##### definition [`CssDocTagDefinition`](CssDocTagDefinition.md) #### Returns `boolean` *** ### setGlobalPrecedence() ```ts setGlobalPrecedence(mode): void; ``` Defined in: [packages/core/src/configuration.ts:147](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L147) Set the global-modifier precedence (see [globalPrecedence](#globalprecedence)). #### Parameters ##### mode `"base"` | `"global"` #### Returns `void` *** ### setInlineComments() ```ts setInlineComments(mode): void; ``` Defined in: [packages/core/src/configuration.ts:134](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L134) Set the inline-comment combine mode. #### Parameters ##### mode [`InlineCommentMode`](../type-aliases/InlineCommentMode.md) #### Returns `void` *** ### setModifierConvention() ```ts setModifierConvention(input): void; ``` Defined in: [packages/core/src/configuration.ts:124](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L124) Set the modifier convention from a preset name or a custom [ModifierConvention](../interfaces/ModifierConvention.md). #### Parameters ##### input [`ModifierConventionInput`](../type-aliases/ModifierConventionInput.md) #### Returns `void` *** ### setNoStandardTags() ```ts setNoStandardTags(): void; ``` Defined in: [packages/core/src/configuration.ts:205](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L205) Disable support for every standard tag (custom tags added later remain supported). #### Returns `void` *** ### setSupportForTag() ```ts setSupportForTag(definition, supported): void; ``` Defined in: [packages/core/src/configuration.ts:194](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L194) Enable or disable support for a tag. #### Parameters ##### definition [`CssDocTagDefinition`](CssDocTagDefinition.md) ##### supported `boolean` #### Returns `void` *** ### setSupportForTags() ```ts setSupportForTags(definitions, supported): void; ``` Defined in: [packages/core/src/configuration.ts:200](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L200) Enable or disable support for several tags. #### Parameters ##### definitions readonly [`CssDocTagDefinition`](CssDocTagDefinition.md)\[] ##### supported `boolean` #### Returns `void` *** ### tryGetTagDefinition() ```ts tryGetTagDefinition(tagName): CssDocTagDefinition | undefined; ``` Defined in: [packages/core/src/configuration.ts:184](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L184) Look up a tag definition by name (with or without a leading `@`). #### Parameters ##### tagName `string` #### Returns [`CssDocTagDefinition`](CssDocTagDefinition.md) | `undefined` *** ### standardTags() ```ts static standardTags(): CssDocTagDefinition[]; ``` Defined in: [packages/core/src/configuration.ts:216](https://github.com/thedannywahl/cssdoc/blob/main/packages/core/src/configuration.ts#L216) A fresh set of the standard tag definitions (new instances on each call), built from the spec. #### Returns [`CssDocTagDefinition`](CssDocTagDefinition.md)\[]