follow-js v2.3.0

follow.js

follow.js is an experimental, dependency free script that lets elements follow your cursor without a huge overhead.

Documentation / Examples

Getting started

Include script

You can do this through npm npm i -s follow-js ...

import Follow from "follow-js";

... with skypack.dev ...

import Follow from "https://cdn.skypack.dev/follow-js";

... or download the follow.min.js file and include it in your html.

<script src="follow.min.js"></script>

Otherwise, you have the option to use it with unpkg, jsdeliver or similar services.

Add elements

To create an element which follows the cursor, you now have to add the data-follow attribute (the name of the attribute can be changed through the options) to any tag you want.

<div data-follow>...</div>

Initialization

After you included the script in your application, you have to initialize follow.js. This can be done automatically, if you included it via script tag and add the data-follow-auto attribute to it

<script src="follow.min.js" data-follow-auto></script>

or manually through js.

const follow = new Follow();

Options

You have the possibility to define or override the default options of an instance, according to your needs. To do so, you have to pass an object with the wanted options in it to the constructor as following:

const follow = new Follow({
  debug: true,
  factor: 50,
  attribute: "follow",
  initiate: false,
});

Available options

Methods

After you initialized a new follow instance, you have multiple methods available. You can call them on your instance as following:

const follow = new Follow() < br > follow.destroy();

Available methods

Featured projects

If you want your project that you've done with the follow.js Script to be featured on this page, please open an issue with the link to the project and a short description.

Links

follow.js is open source. You can find the source code on Github, and the distributed version on npm.

Issues / Questions

If you have any issues or questions with the script, you can open an issue on Github.

Contributions

Any contributions are welcome. Please fork the project and develop with small, focused commits so its easier for the reviewer to understand what you've done. After you're done with development, create a pull request to the development branch. We'll then have a look at the code and give you feedback.

Version history