Skip to content
This repository has been archived by the owner on Oct 29, 2019. It is now read-only.

ritterim/preload-hover

Repository files navigation

Preload Hover

Build status npm version

Installation

npm install preload-hover

Or, load this script manually: https://unpkg.com/preload-hover@latest/lib/preload-hover.min.js -- This targets the latest version, which may include breaking changes for major version updates. A specific version can be targeted to avoid potential breaking changes. See https://unpkg.com for more information.

Quickstart

new PreloadHover().start();

Usage

  • Run new PreloadHover().start();, optionally specifying the scope in the parameter (defaults to document.body).

Configuration options can be specified in the PreloadHover constructor. Example:

new PreloadHover({
  defaultDomScope: document.getElementById('preload-container')
}).start();

Configuration options

Option Description Default Value
defaultDomScope The default DOM scopes to use. [document.body]
debounceTime The time in milliseconds to wait before adding preload link. 50
linkType The types of links to include. ('local', 'external', 'both') 'local'

Methods

start(domScopes = this.configuration.defaultDomScope)

Activate preload on hover for a tags inside domScopes.

Development

  • npm install
  • npm start to run demo.
  • npm run build or npm run watch
  • npm test or npm run test:watch to run tests.
  • npm run lint to run linter.
  • npm run validate to run linter followed by tests.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published