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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- modelValuerequisstring | 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.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Edit-in-place title with async validation