up.link up.deferred.load(placeholder, [options])

JavaScript function

The [up-defer] placeholder to load.

Render options that should be used for loading the placeholder.

Unpoly will parse render options from the given placeholder's attributes. You may pass this additional options object to supplement or override options parsed from the placeholder attributes. See [up-follow] for a list of supported attributes.

Common options are documented below, but most options for up.follow() may be used.

A selector for the fragment to render the content in.

By default the [up-defer] element itself will be replaced with the loaded content. For this the element must have a derivable target selector.

You may target one or multiple fragments. To target the placeholder itself, you can use :origin target instead of spelling out a selector.

The URL from which to load the deferred content.

Defaults to the placeholder's [up-href] or [href] attribute.

An 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 targeted CSS selector. See up.protocol for details.

Whether to load the deferred content in the background.

Background requests will not show the global progress bar.

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. 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 { cache: 'auto' } Unpoly will use the cache only if up.network.config.autoCache returns true for the request.

With { cache: false } Unpoly will always make a network request.

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

With { revalidate: 'auto' } Unpoly will revalidate expired responses.
This behavior can be configured with up.fragment.config.autoRevalidate(response).

With { revalidate: true } Unpoly will always revalidate cached content, regardless of its age.

With { revalidate: false } Unpoly will never revalidate cached content.

A preview that that runs while revalidating cached content.

Whether existing cache entries will be expired with this request.

Expired content remains in the cache, but will be revalidated with the server after rendering.

By default, any non-GET request will expire the entire cache. This can be configured with up.network.config.expireCache.

To only expire 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.

Whether existing cache entries will be evicted with this request.

By default, Unpoly will never evict entries while the cache has space, preferring expiration instead. This can be configured with up.network.config.evictCache.

To only evict 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.