IInlineEditProps
interface
Form & Input
Props contract for OrigamInlineEdit — the edit-in-place component. Controls validation rules, auto-focus, select-on-focus, confirm/cancel triggers, multiline mode, and built-in action buttons.
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.
- modelValuerequiredstring | number
- Current value (v-model target). Accepts string or number.
- placeholderstring
- Placeholder shown on the input and in the default display slot when the value is empty.
- rulesArray<TInlineEditRule>
- Array of validation rules evaluated on confirm. First failure blocks the commit.
- validateTInlineEditValidator
- Sync or async validation callback. Runs after rules pass. Returns true or an error message.
- autoFocusbooleantrue
- Auto-focus the input when entering edit mode.
- selectOnFocusbooleantrue
- Select all text when the input gains focus on edit entry.
- confirmOnBlurbooleantrue
- Confirm the draft when the input loses focus.
- confirmOnEnterbooleantrue
- Confirm on Enter. Disable for multiline mode where Enter should insert a newline.
- cancelOnEscapebooleantrue
- Cancel (revert) the draft on Escape.
- disabledbooleanfalse
- Disables the component. The display affordance becomes non-interactive.
- multilinebooleanfalse
- Render a <textarea> instead of <input> in edit mode.
- trimbooleantrue
- Strip surrounding whitespace before emitting and validating.
- inputTypeTInlineEditInputType'text'
- Native HTML input type when not in multiline mode.
- loadingOnConfirmbooleanfalse
- Surface a loading affordance (CSS class hook) while an async validator is in flight.
- showActionsbooleanfalse
- Render built-in Edit / Confirm / Cancel icon buttons next to the component.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Edit-in-place title with async validation