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
| Property | Type | Description |
|---|---|---|
| defaultValue | Value | The value the field starts with. While the field holds it, the field writes nothing into the code block, unless it is CodeBlockBuilderFieldBase.isRequired. |
| description? | string | A description shown under the field's name. |
| isRequired? | boolean | Whether the field is always written into the code block. A required field is shown above the optional ones and has no reset button. |
| key | string | The key the field's line is written with, and the key of its value in the values the preview receives. Unique across all fields. |
| name | string | The name of the field, shown to the user. |
| shouldOmitKey? | boolean | Whether the field's line holds its value alone, without the key: prefix. |
Links to this page: