Edit this page

up.link up.link.config
JavaScript property

Configures defaults for link handling.

In particular you can configure Unpoly to handle all links on the page without requiring developers to set [up-...] attributes.

Value

config.followSelectors Array<string>

An array of CSS selectors matching links that will be followed through Unpoly.

You can customize this property to automatically follow all links on a page without requiring an [up-follow] attribute. See Handling all links and forms.

config.noFollowSelectors Array<string>

Exceptions to config.followSelectors.

Matching links will not be followed through Unpoly, even if they match config.followSelectors.

By default Unpoly excludes:

  • Links with an [up-follow=false] attribute.
  • Links with a cross-origin [href].
  • Links with a [target] attribute (to target an iframe or open new browser tab).
  • Links with a [download] attribute.
  • Links with an [href] attribute starting with javascript:.
  • Links with an [href="#"] attribute that don't also have local HTML in an [up-document], [up-fragment] or [up-content] attribute.
config.instantSelectors Array<string>

An array of CSS selectors matching links that are followed on mousedown instead of on click.

You can customize this property to follow all links on mousedown without requiring an [up-instant] attribute. See Handling all links and forms.

Note that an instant link must also by followable, usually by giving it an [up-follow] attribute or by configuring up.link.config.followSelectors.

config.noInstantSelectors Array<string>

Exceptions to config.followSelectors.

Matching links will not be followed through Unpoly, even if they match config.followSelectors.

By default Unpoly excludes:

  • Links with an [up-instant=false] attribute.
  • Links that are not followable.
config.preloadSelectors Array<string>

An array of CSS selectors matching links that are preloaded on hover.

You can customize this property to preload all links on mousedown without requiring an [up-preload] attribute. See Handling all links and forms.

config.noPreloadSelectors Array<string>

Exceptions to config.preloadSelectors.

Matching links will not be preloaded on hover, even if they match config.preloadSelectors.

By default Unpoly excludes:

[config.preloadDelay=75] number optional

The number of milliseconds to wait before [up-preload] starts preloading.

[config.preloadEnabled='auto'] booleanorstringorFunction(Element): booleanorstring optional

Whether Unpoly will load preload requests.

With the default setting ("auto") Unpoly will load preload requests unless up.network.shouldReduceRequests() detects a poor connection.

If set to true, Unpoly will always preload links.

If set to false, Unpoly will never preload links.

You may also configure a function that accepts a link element and returns true, false or 'auto'.

Regardless of what you configure here, Unpoly will only preload links with safe methods.

[config.clickableSelectors] Array<string> optional experimental

A list of CSS selectors matching elements that should behave like links or buttons.

To make the link-like element as accessible as possible, it gains the following behaviors:

  • The element is given an [role=link] attribute so screen readers announce it as link.
  • The element shows pointer cursor when hovered over.
  • The element can be focused with the keyboard.
  • The element emits an up:click event when activated.
  • You may also assign an [up-instant] attribute to make the element activate on mousedown instead of click.

See [up-clickable], [up-href].

This website uses cookies to improve usability and analyze traffic.
I accept or learn more