Linking to fragments `up.follow(linkOrSelector, [options])` function

Follows the given link via AJAX and replaces a CSS selector in the current page with corresponding elements from a new page fetched from the server.

Any Unpoly UJS attributes on the given link will be honored. E. g. you have this link:

<a href="/users" up-target=".main">Users</a>

You can update the page's .main selector with the .main from /users like this:

var $link = $('a:first'); // select link with jQuery
up.follow($link);

The unobtrusive variant of this are the a[up-target] and a[up-follow] selectors.

Parameters

linkOrSelector Element or jQuery or String

An element or selector which resolves to an <a> tag or any element that is marked up with an up-href attribute.

[options.target] String optional

The selector to replace. Defaults to the up-target attribute on link, or to body if such an attribute does not exist.

[options.failTarget] String optional

The selector to replace if the server responds with a non-200 status code. Defaults to the up-fail-target attribute on link, or to body if such an attribute does not exist.

[options.fallback] String optional

The selector to update when the original target was not found in the page.

[options.method='get'] String optional

The HTTP method to use for the request.

[options.confirm] String optional

A message that will be displayed in a cancelable confirmation dialog before the link is followed.

[options.transition] Function or String optional

A transition function or name.

[options.failTransition] Function or String optional

The transition to use if the server responds with a non-200 status code.

[options.duration] Number optional

The duration of the transition. See up.morph().

[options.delay] Number optional

The delay before the transition starts. See up.morph().

[options.easing] String optional

The timing function that controls the transition's acceleration. up.morph().

[options.reveal] Element or jQuery or String optional

Whether to reveal the target element within its viewport before updating.

[options.restoreScroll] Boolean optional

If set to true, this will attempt to restore scroll positions previously seen on the destination URL.

[options.cache] Boolean optional

Whether to force the use of a cached response (true) or never use the cache (false) or make an educated guess (undefined).

[options.headers={}] Object optional

An object of additional header key/value pairs to send along with the request.

[options.timeout={}] Object optional

A timeout in milliseconds for the request.

[options.layer='auto'] String optional

The name of the layer that ought to be updated. Valid values are auto, page, modal and popup.

If set to auto (default), Unpoly will try to find a match in the same layer as the given link. If no match was found in that layer, Unpoly will search in other layers, starting from the topmost layer.

[options.failLayer='auto'] String optional

The name of the layer that ought to be updated if the server sends a non-200 status code.

Return value

Promise

A promise that will be resolved when the link destination has been loaded and rendered.

Linking to fragments up.follow(linkOrSelector, [options]) function

Parameters

Return value

Linking to fragments `up.follow(linkOrSelector, [options])` function