Giter Club home page Giter Club logo

jquery-attract-hover's Introduction

Attract Hover

Creates an 'attract' effect, when the mouse is near an element and within bounds. ๐Ÿ–ฑโšช๏ธ

Example

You can see an example of this working over on Codepen

Requirements

This plugin currently requires jQuery 2.x+, but we'd recommend using jQuery 3.x+.

Install

You can install via npm:

npm install attract-hover

Or, manually by copying the attractHover.js from /dist/ and placing it inside your project folders.

Initialise

To initialise the plugin, use the code below in your JS file.

   $.attractHover(
   	'.js-attract-hover',
   	{
   		proximity: 20,
   		magnetism: 4
   	}
   );

Then add the selector to the element you want to have the attract effect to.

<a href="/" class="js-attract-hover">
   Button
</a>

Options

You can overwrite the plugin options e.g. $.attractHover('.js-attract', { proximity: 10 });. The options for the plugin can be found below:

Name Type Default Value Description
proximity integer 30 Defines the area around the element that starts the interaction.
magnetism integer 3 Defines how far the element can move based on the mouse position and element size.
attractClass string attract-hover Class wrapped around your attracted element that gets added dynamically.
attractEasingClass string attract-hover-easing Class that moves your attracted element that gets added dynamically.
attractAttractedClass string attract-hover-attracted Class that is added when the element is attracted.

CSS / Easing

Although theres no need to add any CSS / easing to your elements as the attract hover adds CSS itself dynamically. We recommend adding some form of transition and easing to make the attract effect seem more elastic.

This is best added to the .attract-hover-easing in your own CSS (Unless you've changed the attractEasingClass option on the plugin.)

.attract-hover-easing {
   transition: all 0.3s cubic-bezier(0.250, 0.460, 0.450, 0.940);
}

Roadmap

  • Vanilla version
  • More debugging in browsers and devices

jquery-attract-hover's People

Contributors

bymayo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

wumzee97

jquery-attract-hover's Issues

Temporarily disable and re-enable attraction

What's the best way to temporarily disable attraction and re-enable later? I've tried removing classes and redefining the options but none of them seem to remove the effect.

Thanks, great little effect by the way!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.