Clear, Reset & Focus
State management methods for forms and fields.
clear()
Clear the field or form to empty values. Available on Form and Field instances.
form.clear(); // clear all fields
form.$('username').clear(); // clear a single field- Sets the field value to its empty/default type value (based on
fallbackValueoption) - Resets
touched,blurred,changed, andfiles - If
validateOnClearis enabled, re-validates the field - Recursively clears nested fields by default
This is an action, not an Event Handler. Use
onClear(e)to trigger hooks.
reset()
Reset the field or form to its default value. Available on Form and Field instances.
form.reset(); // reset all fields to defaults
form.$('username').reset(); // reset a single field- If
defaultdiffers frominitial, usesdefault - Otherwise uses
initial - Resets
touched,blurred,changed, andfiles - If
validateOnResetis enabled, re-validates the field - Recursively resets nested fields by default
This is an action, not an Event Handler. Use
onReset(e)to trigger hooks.
focus()
Programmatically focus the field. Requires a ref to be attached to the input.
form.$('username').focus();The ref is set automatically when using bind():
<input {...field.bind()} />Or manually:
<input ref={(ref) => field.set('ref', ref)} />blur()
Programmatically blur the field. Requires a ref.
form.$('username').blur();The blur() method:
- Calls
ref.blur()on the DOM element (if a ref is attached) - Sets
$focused = false - Sets
$blurred = true
Useful for dismissing keyboard focus after a successful action:
function handleSubmitSuccess() {
form.$('username').blur();
form.$('email').blur();
}trim()
Remove whitespace from the field value if it is a string. Does not trigger the onChange Event Hook.
field.trim();
// field.value is now trimmed, no onChange hook firesUseful for pre-submit processing. For automatic trimming on every change, use the
autoTrimValueform option.