ITextareaFieldProps
interface
Forms & Inputs
Full prop surface for <OrigamTextareaField> — extends field, input, color, density, adjacent-inner, padding/margin, border, rounded and elevation contracts. Adds auto-grow, rows, counter, prefix/suffix, rich mode and toolbar configuration.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- autoGrowboolean
- Automatically grows the textarea height to fit its content.
- autofocusboolean
- Focuses the textarea on mount.
- counterboolean | number | string
- Shows a character counter. Pass a number to set the max.
- counterValuenumber | ((e: any) => number)
- Custom function or fixed number for the counter value.
- persistentClearboolean
- Keeps the clear button visible even when the field is not focused.
- prefixstring
- Text rendered before the textarea value (inside the control).
- placeholderstring
- Placeholder text shown when the field has no value.
- persistentPlaceholderboolean
- Keeps the placeholder visible even when a value is set.
- persistentCounterboolean
- Keeps the counter visible even when the field is not focused.
- noResizeboolean
- Disables manual resize handle on the textarea.
- rowsnumber | string
- Initial number of visible text rows.
- maxRowsnumber | string
- Maximum number of rows when auto-grow is enabled.
- suffixstring
- Text rendered after the textarea value (inside the control).
- modelModifiersstring | boolean
- Vue model modifiers applied to the v-model binding.
- modeTTextareaMode
- Render mode. 'plain' (default) uses a native <textarea>. 'rich' uses a contenteditable surface with toolbar.
- outputTTextareaOutput
- When mode='rich', format of the emitted value. 'html' (default) or 'markdown'.
- toolbarReadonlyArray<TTextareaToolbarCommand> | false
- Ordered list of toolbar commands to show in rich mode. Pass false to hide the toolbar.
- toolbarPositionTTextareaToolbarPosition
- Position of the toolbar relative to the editing surface in rich mode.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Rich textarea with toolbar