up.layer [up-layer=new]

HTML attribute

The selector of the root content element to place inside the overlay container.

The target must be matchable within the HTML provided by either the [href], [up-content], [up-fragment], or [up-document] attribute.

If the attribute is omitted, Unpoly will use the first matching main target configured for the overlay mode. For example, the default selectors for modals are configured in up.layer.config.modal.mainTargets. See main targets in overlays.

Whether to stack the new overlay or replace existing overlays.

The following values are supported:

For popups, the position of the popup relative to the link or button that opened the overlay. See popup position.

For drawers, the screen edge on which to position the drawer (left or right). See drawer position.

For popups, the alignment of the popup within its { position }. See popup position.

The URL to fetch from the server.

See loading content from a URL.

To use a different URL when a link is followed through Unpoly (as opposed to a browser's full page load), set an [up-href] attribute.

Instead of making a server request, you may also render an existing string of HTML.

The HTTP method to use for the request.

Common values are get, post, put, patch and delete. The value is case-insensitive.

The HTTP method may also be passed as a [data-method] attribute.

By default, methods other than get or post will be converted into a post request, and carry their original method as a configurable _method parameter.

A relaxed JSON object with additional parameters that should be sent as the request's query string or payload.

When making a GET request to a URL with a query string, the given { params } will be added to the query parameters.

A relaxed JSON object with additional request headers.

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

Whether to abort existing requests before rendering.

By default, opening a new overlay will abort all requests within the main element of its base layer.

See aborting requests for details and a list of options.

Whether the request may be aborted by other requests.

By default, the request will be aborted:

• By another request opening another overlay from the same base layer
• By another request targeting the base layer's main element

See Preventing a request from being aborted.

Whether this request will load in the background.

Background requests are deprioritized and won't show the progress bar. See Background requests.

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.

Whether to render error responses differently.

For error responses Unpoly will use attributes prefixed with up-fail, e.g. [up-fail-target].

By default any HTTP status code other than 2xx or 304 is considered an error code. Set [up-fail=false] to handle any response as successful, even with a 4xx or 5xx status code.

The new inner HTML for the targeted fragment.

See Updating an element's inner HTML from a string.

Instead of passing an HTML string you can also pass a template selector, optionally with variables.

A string of HTML comprising only the new fragment's outer HTML.

With an [up-fragment] attribute you can omit the [up-target] attribute. The target will be derived from the root element in the given HTML.

See Rendering a string that only contains the fragment.

Instead of passing an HTML string you can also pass a template selector, optionally with variables.

A string of HTML containing the targeted fragment.

See Extracting an element's outer HTML from a larger HTML string.

Instead of passing an HTML string you can also pass a template selector, optionally with variables.

The kind of overlay to open.

Defaults to up.layer.config.mode, which defaults to 'modal'.

See available layer modes.

The size of the overlay.

See overlay sizes for details.

An optional HTML class for the overlay's container element.

See overlay classes.

How the overlay can be dismissed by the user.

See customizing dismiss controls for details.

You can enable multiple dismiss controls by separating values with a space or comma character.

Passing true or false will enable or disable all dismiss controls.

The data object for the overlay's root content element ([up-target]), encoded as relaxed JSON.

If the content element already has an [up-data] attribute, properties from [up-use-data] take precedence.

The new overlay's context object, encoded as relaxed JSON.

Whether the overlay has visible history.

If set to 'true', the overlay location, title, and meta tags will be shown while the overlay is open. When the overlay is closed, the parent layer's history is restored.

If set to 'auto', history will be visible if the initial overlay content matches a main target.

If set to 'false', fragment changes within the overlay will never update the address bar. You can still access the overlay's current location using up.layer.location.

See History in overlays.

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

See Rendering error 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].

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 attribute from being changed, set [up-lang=false].

This attribute is only used when updating history.

The name of the opening animation.

The timing function that controls the opening animation's acceleration.

The duration of the opening animation in milliseconds.

The name of the closing animation.

The timing function that controls the closing animation's acceleration.

The duration of the closing animation in milliseconds.

An event type that will cause this overlay to automatically be accepted when a matching event occurs within the overlay.

The acceptance value is the event object that caused the overlay to close.

You can listen to multiple event types by separating types with a space or comma.

See Closing when an event is emitted.

An event type that will cause this overlay to automatically be dismissed when a matching event occurs within the overlay.

The dismissal value is the event object that caused the overlay to close.

You can listen to multiple event types by separating types with a space or comma.

See Closing when an event is emitted.

One or more space-separated URL patterns that will cause this overlay to automatically be accepted when the overlay reaches a matching location.

The acceptance value is an object of named segments matches captured by the URL pattern. It also contains the matched URL as a location key.

See Closing when a location is reached.

One or more space-separated URL patterns that will cause this overlay to automatically be dismissed when the overlay reaches a matching location.

The dismissal value is an object of named segments matches captured by the URL pattern. It also contains the matched URL as a location key.

See Closing when a location is reached.

A CSS selector that will cause this overlay to automatically be accepted when a matching element is observed within the overlay.

The acceptance value is the matching fragment's data object.
If the fragment has no data, the value is an empty object.

See Closing when a fragment is detected.

A CSS selector that will cause this overlay to automatically be dismissed when a matching element is observed within the overlay.

The dismissal value is the matching fragment's data object.
If the fragment has no data, the value is an empty object.

See Closing when a fragment is detected.

A JavaScript snippet that is called when the overlay was inserted into the DOM.

The snippet runs in the following scope:

A JavaScript snippet that is called when the overlay is about to be accepted.

The snippet runs in the following scope:

To keep the overlay open, call event.preventDefault(). This has no effect when the overlay is closed because a background layer is being updated.

To run code after the overlay closed, use [up-on-accepted] instead.

A JavaScript snippet that is called when the overlay was accepted.

The snippet runs in the following scope:

To only reload an element, use [up-on-accepted-reload] instead.

A selector to reload after the overlay was accepted.

The element is looked up in the layer that opened the overlay. An element near the link is preferred, and the selector may use :origin to refer to the link.

Unlike [up-on-accepted], this attribute runs no JavaScript, so it needs no CSP nonce. When both attributes are set, the [up-on-accepted] callback runs first.

See Subinteractions: Reloading on acceptance.

A JavaScript snippet that is called when the overlay is about to be dismissed.

The snippet runs in the following scope:

To keep the overlay open, call event.preventDefault(). This has no effect when the overlay is closed because a background layer is being updated.

To run code after the overlay closed, use [up-on-dismissed] instead.

A JavaScript snippet that is called when the overlay was dismissed.

The snippet runs in the following scope:

To only reload an element, use [up-on-dismissed-reload] instead.

A selector to reload after the overlay was dismissed.

The element is looked up in the layer that opened the overlay. An element near the link is preferred, and the selector may use :origin to refer to the link.

Unlike [up-on-dismissed], this attribute runs no JavaScript, so it needs no CSP nonce. When both attributes are set, the [up-on-dismissed] callback runs first.

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

The message will be shown as a native confirmation dialog.

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

The message may also be passed as a [data-confirm] attribute, as rendered by Rails helpers like link_to or button_to.

See Confirmation dialogs, also for showing a styled dialog instead of the browser's.

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 error responses.

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

The snippet runs in the following scope:

To try again, call event.retry().

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.

The following state is considered "finished":

• Animations have concluded and transitioned elements have been removed from the DOM tree.
• Async compilers have settled.
• Cached content has been revalidated with the server.
  If the server has responded with fresher content, that content has also been rendered.

The snippet runs in the following scope:

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.

To run a snippet after an error response has finished rendering, set an [up-on-fail-finished] attribute instead.

Also see Awaiting post-processing.

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.