up.fragment up.render([target], [options])

JavaScript function

The CSS selector to update.

If omitted a main target will be rendered.

You may also pass a DOM element or jQuery element here, in which case a selector will be inferred from the element attributes. The given element will also be used as { origin } for the fragment update.

You may also pass an array of selector alternatives. The first selector matching in both old and new content will be used.

Instead of passing the target as the first argument, you may also pass it as a ´{ target }` option..

The CSS selector to update.

See documentation for the target parameter.

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

If set to a CSS selector string, 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.

Whether this fragment update is considered navigation.

The URL to fetch from the server.

Instead of making a server request, you may also pass an existing HTML string as { document }, { fragment } or { content } option.

The HTTP method to use for the request.

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

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.

An object with additional request headers.

Note that Unpoly will by default send a number of custom request headers. E.g. the X-Up-Target header includes the targeted CSS selector. See up.protocol and up.network.config.requestMetaKeys for details.

The new inner HTML for the fragment.

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

The { target } selector will be derived from the root element in the given HTML:

// This will update .foo
up.render({ fragment: '<div class=".foo">inner</div>' })

If your HTML string contains other fragments that will not be rendered, use the { document } option instead.

If your HTML string comprises only the new fragment's inner HTML, consider the { content } option.

A string of HTML containing the new fragment.

The string may contain other HTML, but only the element matching the { target } selector will be extracted and placed into the page. Other elements will be discarded.

If your HTML string comprises only the new fragment, consider the { fragment } option instead. With { fragment } you don't need to pass a { target }, since Unpoly can derive it from the root element in the given HTML.

If your HTML string comprises only the new fragment's inner HTML, consider the { content } option.

How to render a server response with an error code.

Any HTTP status code other than 2xx is considered an error code.

See handling server errors for details.

Whether the browser URL and window title 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 { title } and { location } options.

If set to 'auto' history will be updated if the { 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.

An explicit document title to use after rendering.

By default the title is extracted from the response's <title> tag. You may also pass { title: false } to explicitly prevent the title from being updated.

Note that the browser's window title will only be updated it you also pass a { history } option.

An explicit URL to use after rendering.

By default Unpoly will use the { url } or the final URL after the server redirected. You may also pass { location: false } to explicitly prevent the URL from being updated.

Note that the browser's URL will only be updated it you also pass a { history } option.

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

If you are prepending or appending content, use the { animation } option 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 { transition } option 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 { cache: true } Unpoly will try to re-use a cached response before connecting to the network. If no cached response exists, Unpoly will make a request and cache the server response.

Also see up.request({ cache }).

Whether existing cache entries will be cleared with this request.

Defaults to the result of up.network.config.clearCache, which defaults to clearing the entire cache after a non-GET request.

To only uncache some requests, pass an URL pattern that matches requests to uncache. You may also pass a function that accepts an existing up.Request and returns a boolean value.

With { solo: true } Unpoly will abort all other requests before laoding the new fragment.

To only abort some requests, pass an URL pattern that matches requests to abort. You may also pass a function that accepts an existing up.Request and returns a boolean value.

The element that triggered the change.

When multiple elements in the current page match the { target }, Unpoly will replace an element in the origin's vicinity.

The origin's selector will be substituted for :origin in a target selector.

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 { layer: 'new' }. In this case options for up.layer.open() may also be used.

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.

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

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

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

How to scroll after the new fragment was rendered.

See scroll option for a list of allowed values.

Whether to save scroll positions before updating the fragment.

Saved scroll positions can later be restored with { scroll: 'restore' }.

What to focus after the new fragment was rendered.

See focus option for a list of allowed values.

A message the user needs to confirm before fragments are updated.

The message will be shown as a native browser prompt.

If the user does not confirm the render promise will reject and no fragments will be updated.

Whether to give the { origin } element an .up-active class while loading and rendering content.

May also pass an element which should receive the .up-active class.

A callback that will be run when when the server responds with new HTML, but before the HTML is rendered.

The callback argument is a preventable up:fragment:loaded event.

A callback that will be run when all animations have concluded and elements were removed from the DOM tree.