tridion-sites-extensions-api-docs

Home > @tridion-sites/models > KeywordFieldDefinition

KeywordFieldDefinition class

Represents a Keyword field definition (in a Schema).

Signature:

export declare class KeywordFieldDefinition extends ItemPublishableFieldDefinition

Extends: ItemPublishableFieldDefinition

Constructors

Constructor	Modifiers	Description
(constructor)({ backendModel, category, defaultValue, list })		Constructs a new instance of the KeywordFieldDefinition class

Properties

Property	Modifiers	Type	Description
_backendModel		BackendKeywordFieldDefinition
allowAutoClassification		boolean	Whether the field supports automatic classification.
category		Link | undefined	Category in which the Keywords must reside.
defaultValue		Link | undefined
getInternalModel		() => BackendKeywordFieldDefinition
list		ListDefinition | undefined	List of allowed values.