Skip to content

CodeBlockBuilderFieldBase<Value>

The members every CodeBlockBuilderField has.

Import:

import type { CodeBlockBuilderFieldBase } from '@mnaoumov/obsidian-lib/modals/code-block-builder';

Signature:

export interface CodeBlockBuilderFieldBase<Value extends CodeBlockBuilderValue>

Properties

PropertyTypeDescription
defaultValueValueThe value the field starts with. While the field holds it, the field writes nothing into the code block, unless it is CodeBlockBuilderFieldBase.isRequired.
description?stringA description shown under the field's name.
isRequired?booleanWhether the field is always written into the code block. A required field is shown above the optional ones and has no reset button.
keystringThe key the field's line is written with, and the key of its value in the values the preview receives. Unique across all fields.
namestringThe name of the field, shown to the user.
shouldOmitKey?booleanWhether the field's line holds its value alone, without the key: prefix.

Links to this page: