CodeBlockBuilderTextField
A text field.
Import:
import type { CodeBlockBuilderTextField } from '@mnaoumov/obsidian-lib/modals/code-block-builder';Signature:
export interface CodeBlockBuilderTextField extends CodeBlockBuilderFieldBase<string>Extends: CodeBlockBuilderFieldBase<string>
Properties
| Property | Type | Description |
|---|---|---|
| defaultValue | string | 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) |
| placeholder? | string | A placeholder shown while the field is empty. |
| shouldOmitKey? | boolean | Whether the field's line holds its value alone, without the key: prefix.(Inherited from CodeBlockBuilderFieldBase) |
| type | 'text' | The kind of the field. |
| validationPattern? | RegExp | A pattern the value must match. While it does not, the field is marked invalid and keeps its last valid value. |
Links to this page: