CodeBlockBuilderBooleanField
A boolean field, rendered as a toggle.
Import:
import type { CodeBlockBuilderBooleanField } from '@mnaoumov/obsidian-lib/modals/code-block-builder';Signature:
export interface CodeBlockBuilderBooleanField extends CodeBlockBuilderFieldBase<boolean>Extends: CodeBlockBuilderFieldBase<boolean>
Properties
| Property | Type | Description |
|---|---|---|
| defaultValue | boolean | The value the field starts with. While the field holds it, the field writes nothing into the code block, unless it is CodeBlockBuilderFieldBase.isRequired. (Inherited from CodeBlockBuilderFieldBase) |
| description? | string | A description shown under the field's name. (Inherited from CodeBlockBuilderFieldBase) |
| 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. (Inherited from CodeBlockBuilderFieldBase) |
| 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. (Inherited from CodeBlockBuilderFieldBase) |
| name | string | The name of the field, shown to the user. (Inherited from CodeBlockBuilderFieldBase) |
| shouldOmitKey? | boolean | Whether the field's line holds its value alone, without the key: prefix.(Inherited from CodeBlockBuilderFieldBase) |
| type | 'boolean' | The kind of the field. |
Links to this page: