up.form [up-submit]

HTML selector

The target selector to update for a successful form submission.

The target selector to update when the server responds with an error code.

By default, failed responses will update the <form> element itself.

See Handling failed responses.

Specifies behavior if the target selector is missing from the current page or the server response.

If set to a CSS selector, Unpoly will attempt to replace that selector instead.

If set to true, Unpoly will attempt to replace a main target instead.

If set to false, Unpoly will immediately reject the render promise.

Controls which fragment to update when the [up-target] selector yields multiple results.

When set to 'region' Unpoly will prefer to update fragments in the region of the origin element.

If set to 'first' Unpoly will always update the first matching fragment.

Defaults to up.fragment.config.match, which defaults to 'region'.

Whether [up-hungry] elements outside the updated fragment will also be updated.

Whether this fragment update is considered navigation.

Setting this to false will disable most defaults documented below, causing Unpoly to render a fragment without side-effects like updating history or scrolling.

Where to send the form data when the form is submitted.

The HTTP method to use for the request.

The value is case-insensitive.

You can also use methods that would not be allowed on a <form> element, such as 'patch' or 'delete'. These will be wrapped in a POST request.

Additional Form parameters that should be sent as the request's query string or payload.

The given value will be added to params parsed from the form's input fields. If a param with the same name already existed in the form, it will be deleted and overridden with the given value.

A relaxed JSON object with additional request headers.

Unpoly will by default send a number of custom request headers. E.g. the X-Up-Target header includes the target selector. See up.protocol for details.

Whether to abort existing requests before rendering.

Whether this request may be aborted by other requests targeting the same fragments or layer.

See aborting requests for details.

Whether this request will load in the background.

Background requests deprioritized over foreground requests. Background requests also won't emit up:network:late events and won't trigger the progress bar.

The number of milliseconds after which this request can cause an up:network:late event.

Defaults to up.network.config.lateDelay.

The number of milliseconds after which this request fails with a timeout.

Defaults to up.network.config.timeout.

The layer in which to match and render the fragment.

See layer option for a list of allowed values.

To open the fragment in a new overlay, pass [up-layer=new]. In this case attributes for [up-layer=new] may also be used.

The layer in which render if the server responds with an error code.

See Rendering failed responses differently.

Whether to close overlays obstructing the updated layer when the fragment is updated.

This is only relevant when updating a layer that is not the frontmost layer.

Whether the browser URL, window title and meta tags will be updated.

If set to true, the history will always be updated, using the title and URL from the server response, or from given [up-title] and [up-location] attributes.

If set to auto history will be updated if the [up-target] matches a selector in up.fragment.config.autoHistoryTargets. By default this contains all main targets.

If set to false, the history will remain unchanged.

See Updating history.

Whether to update history when the server responds with an error code.

See Rendering failed responses differently.

An explicit document title to set before rendering.

By default the title is extracted from the response's <title> tag. To prevent the title from being updated, set [up-title=false] to explicitly

This attribute is only used when updating history.

An explicit URL to set before rendering.

By default Unpoly will use the link's [href] or the final URL after the server redirected. To prevent the URL from being updated, set [up-location=false].

This attribute is only used when updating history.

Whether to update meta tags in the <head>.

By default Unpoly will extract meta tags from the response's <head>. To prevent meta tags from being updated, set [up-meta-tags=false].

This attribute is only used when updating history.

An explicit language code to set as the html[lang] attribute.

By default Unpoly will extract the language from the response and update the html[lang] attribute in the current page. To prevent the attrribute from being changed, set [up-lang=false].

This attribute is only used when updating history.

The name of an transition to morph between the old and few fragment.

If you are prepending or appending content, use the [up-animation] attribute instead.

The name of an animation to reveal a new fragment when prepending or appending content.

If you are replacing content (the default), use the [up-transition] attribute instead.

The duration of the transition or animation (in millisconds).

The timing function that accelerates the transition or animation.

See MDN documentation for a list of available timing functions.

Whether to read from and write to the cache.

With [up-cache=true] Unpoly will try to re-use a cached response before connecting to the network. To prevent display of stale content, cached responses are reloaded once rendered. If no cached response exists, Unpoly will make a request and cache the server response.

With [up-cache=auto] Unpoly will use the cache only if up.network.config.autoCache returns true for the request. By default this only caches GET requests.

With [up-cache=false] Unpoly will always make a network request.

Whether to reload the targeted fragment after it was rendered from a cached response.

With [up-revalidate='auto'] Unpoly will revalidate expired responses.
This behavior can be configured with up.fragment.config.autoRevalidate(response).

With [up-revalidate='true'] Unpoly will always revalidate cached content, regardless of its age.

With [up-revalidate='false'] Unpoly will never revalidate cached content.

The name of a preview that runs while revalidating cached content.

Whether existing cache entries will be expired with this request.

By default a non-GET request will expire the entire cache. You may also pass a URL pattern to only expire matching requests.

Also see up.request({ expireCache }) and up.network.config.expireCache.

Whether existing cache entries will be evicted with this request.

You may also pass a URL pattern to only evict matching requests.

Also see up.request({ evictCache }) and up.network.config.evictCache.

How to scroll after the new fragment was rendered.

See Scrolling for a list of allowed values.

How to scroll after the new fragment was rendered from a failed response.

See Rendering failed responses differently.

Whether to animate the scroll motion when prepending or appending content.

When to snap to the top when scrolling to an element near the top edge of the viewport's scroll buffer.

When to move a revealed element to the top when scrolling to an element.

How much space to leave to the closest viewport edge when scrolling to an element.

How many pixel lines of high element to reveal when scrolling to an element.

Whether to save scroll positions before updating the fragment.

Saved scroll positions can later be restored with [up-scroll=restore].

What to focus after the new fragment was rendered.

See Controlling focus for a list of allowed values.

What to focus after the new fragment was rendered from a failed response.

See Rendering failed responses differently.

Whether the focused element should have a visible focus ring.

By default focus will be visible if up.viewport.config.autoFocusVisible() returns true for the focused element and current input device.

Whether to save focus-related state before updating the fragment.

Saved scroll positions can later be restored with [up-focus=restore].

Disables form controls while the request is loading.

The values of disabled fields will still be included in the submitted form params.

A placeholder to show in the targeted fragment while new content is loading.

Existing children of the targeted fragment will be hidden during the request. When the request ends for any reason, all changes will be reverted.

You can either pass a HTML string or refer to a template, optionally with variables.

If this link opens a new overlay, the placeholder will be shown temporary overlay with the same visual style and open animation.

The name of a preview that temporarily changes the page while new content is loading.

The preview changes will be reverted automatically when the request ends for any reason.

Whether to set feedback classes while loading content.

A relaxed JSON object that overrides properties from the new fragment's data.

Whether [up-keep] elements will be preserved in the updated fragments.

A relaxed JSON object that will be merged into the context of the current layer once the fragment is rendered.

A message the user needs to confirm before any request or changes are made.

The message will be shown as a native browser prompt.

If the user does not confirm, no request is sent and no fragments are updated.

A JavaScript snippet that is executed when the server responds with new HTML, but before the HTML is rendered.

The snippet runs in the following scope:

The snippet will also run for failed responses.

A JavaScript snippet that is executed when the fragment could not be loaded due to a disconnect or timeout.

A JavaScript snippet that is executed when Unpoly has updated fragments.

The snippet runs in the following scope:

The snippet will be called zero, one or two times:

• When the server rendered an empty response, no fragments are updated. [up-on-rendered] is not called.
• When the server rendered a matching fragment, it will be updated on the page. [up-on-rendered] is called with the result.
• When revalidation renders a second time, [up-on-rendered] is called again with the final result.

Also see Running code after rendering.

A JavaScript snippet that is executed when no further DOM changes will be caused by this render pass.

In particular:

• Animations have concluded and transitioned elements were removed from the DOM tree.
• A cached response was revalidated with the server. If the server has responded with new content, this content has also been rendered.

If revalidation re-rendered the fragment, result describes updates from the second render pass. If no revalidation was performed, or if revalidation yielded an empty response, it is the result from the initial render pass.

Also see Awaiting postprocessing.

A JavaScript snippet that is run when any error is thrown during the rendering process.

The callback is also called when the render pass fails due to network issues, or aborts.

Also see Handling errors.