FieldMetadata

View as Markdown

FieldMetadata

Metadata details for the field.

NameTypeDescription
AllowRichText bool

Determines whether the editor will support rich text, and is set to ‘true’ by default for Rich Text Editors.

Default string

Allows you to set default fields for content types.

DefaultValue object

Allows you to set a default value for a field.

Description string

Allows you to provide the content for the Rich text editor field.

Instruction string

Allows you to add instructions for the content managers while entering values for a field. The instructional text appears below the field.

Markdown bool

Lets you assign a field to be a markdown by setting its value to ‘true’.

Multiline bool

Provides multi-line capabilities to the Rich text editor.

Options List<string>

If you choose the Custom editor, then the options key lets you specify the formatting options you prefer for your RTE toolbar, e.g., "options": ["h3", "blockquote", "sup"]

Placeholder string

Allows you to provide a hint text about the values that need to be entered in an input field, e.g., Single Line Textbox. This text can be seen inside the field until you enter a value.

RefMultiple bool

Allows you to set single or multiple reference to Reference field.

RichTextType string

Lets you enable either the basic, custom, or advanced editor to enter your content.

Version int

This key determines whether you are using the older version of the Rich Text Editor or the latest version. The value of 1 denotes that it is an older version of the editor, while 3 denotes that it is the latest version of the editor.