3.15
Search docs… /
Menu
Skill

API reference up.form
module

Features to submit and validate forms without a full page load.

Set an [up-submit] attribute to let Unpoly handle a form, or call up.submit() from JavaScript. The up:form:submit event lets your code observe or prevent any submission.

To render a new form state while the user is still typing, mark fields with [up-validate]. This shows validation errors as the user moves through the form, and can update other fields that depend on the changed value. [up-switch] shows, hides or disables other elements depending on a field's value, without a server request. [up-autosubmit] submits the form whenever a field changes, and up.watch() runs your own callback instead.

Features

  • up.autosubmit(element, [options]) JS

    Automatically submits a form when a field changes.

  • [up-autosubmit] ATTR

    Automatically submits a form when a field changes.

  • [up-disable-for] ATTR

    Disables this element while an input field with [up-switch] has one of the given values.

  • [up-enable-for] ATTR

    Enables this element while an input field with [up-switch] has one of the given values.

  • [up-fieldset] ATTR deprecated

    Marks this element as a from group, which (usually) contains a label, input and error message.

  • up.form.config CONFIG

    Sets default options for form submission and validation.

  • up.form.fields(root) JS

    Returns a list of form fields within the given element.

  • up.form.group(element, [options]) JS experimental

    Returns the form group for the given element.

  • [up-form-group] ATTR

    Marks this element as a form group, which (usually) contains a label, input and error message.

  • up.form.isField(element) JS

    Returns whether the given element is a form field, such as input or select.

  • up.form.isSubmittable(form) JS

    Returns whether the given form will be submitted through Unpoly instead of making a full page load.

  • up:form:submit EVENT

    This event is emitted when a form is submitted through Unpoly.

  • up.form.submitButtons(root) JS experimental

    Returns a list of submit buttons within the given element.

  • up.form.submitOptions(form) JS

    Parses the render options that would be used to submit the given form, but does not render.

  • up:form:switch EVENT

    When an [up-switch] field changes, this event is emitted on all dependent elements.

  • up:form:validate EVENT

    This event is emitted before a form is being validated.

  • [up-hide-for] ATTR

    Hides this element while an input field with [up-switch] has one of the given values.

  • [up-observe] ATTR deprecated

    Watches form fields and runs a callback when a value changes.

  • up.observe(elements, [options], onChange) JS deprecated

    Observes form fields and runs a callback when a value changes.

  • [up-show-for] ATTR

    Only shows this element if an input field with [up-switch] has one of the given values.

  • up.submit(form, [options]) JS

    Submits a form via JavaScript and updates a fragment with the server response.

  • [up-submit] ATTR

    Submits this form via JavaScript and updates a fragment with the server response.

  • [up-switch] ATTR

    Controls the state of another element when this field changes.

  • up.validate(element, options, [options]) JS

    Renders a new form state from its current field values, to show validation errors or update dependent elements.

  • [up-validate] ATTR

    Renders a new form state when a field changes, to show validation errors or update dependent elements.

  • up.watch(element, [options], callback) JS

    Watches form fields and runs a callback when a value changes.

  • [up-watch] ATTR

    Watches form fields and runs a callback when a value changes.