graviton.js

1.0.2 • Public • Published

npm version

Graviton.js

Graviton.js is an open-source simple and efficient JavaScript front-end library to add a cool Parallax effect to your projects.

How to add Graviton to your proyect

You have two ways to add Graviton into your project.

NPM INSTALL

You can install Graviton via npm with:
npm install graviton.js

MANUAL ADDING

If you dont want to install node dependencies, you can also manually add graviton.js script by downloading the JavaScript file "graviton.min.js" and including it in your project.

How to Use

To start using Graviton.js, add your element the "graviton" class, and include a "data-gravity" atribute. This atribute goes from -10 to 10 (default or 0 = 3). Example:
&lth1 class="graviton" data-gravity="3"&gtHi Graviton!&lt/h1&gt

Contribute to this proyect

If you find bugs, improvements or new ideas, feel free to modify this repository.
  1. Fork this repository.
  2. Make your changes on the base file (graviton.js).
  3. Minify your code and substitute "graviton.min.js" file.
  4. Make a pull request.

License

This project is licensed under the MIT - see the LICENSE file for details.

Package Sidebar

Install

npm i graviton.js

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

7.06 kB

Total Files

5

Last publish

Collaborators

  • mariiom