IInlineEditEditSlotBindings

interface
Slots

Scoped slot bindings exposed by the #edit slot of OrigamInlineEdit — gives full control over the input layout while delegating state-machine logic to the component.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

value
required
string
Current draft value (two-way; mutate via setValue).
setValue
required
(next: string) => void
Update the draft value from within the slot.
confirm
required
() => void
Run the validator and, if it passes, commit the draft.
cancel
required
() => void
Discard the draft and return to display mode.
error
required
string | null
Current validation error message, or null when none.
isPending
required
boolean
True while an async validator is in flight.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom textarea input in the #edit slot

vue