qanimate v1.0.2
qAnimate - Create awesome components! :rainbow: :thought_balloon:
qAnimate is a jQuery Plugin that contains useful animations to use on all kinds of web proyects, containing sliders, text effects, etc. All made with JS
The idea behind this project is to provide the logic that make work all the elements, leaving to the developer the task to implement styles, including animations, structure, times, etc.
Using this idea you can make fully customizable components for your applications/website faster than making it all from scratch.
Who wants this "pre made look" on your cool website? :wink:
How to install
First, make sure you have installed jQuery and it is included in your application
<script src="path/to/the/file/jquery-x.y.z.min.js">
It is required by qAnimate since it is a jQuery plugin.
To install qAnimate clone this repo or run in your console:
npm install qanimate
Then include in your HTML with a line like this:
<script src="path/to/the/file/qanimate.js">
If you installed via NPM you can find the project files in /node-modules
Functions
You can find more in-depth documentation in the Wiki
makeSlider({options})
Provides the logic required to make a functional slider, it works by scrolling between the different components on a scrolling container.
makeMenu({options})
Makes a side/offCanvas menu (you can style it as you want), customization is allways a developer task, makeMenu does not provide any pre-made style.
fadeInWithAnim(delay, selectedClass)
Applies a fadeIn animation to every element in a selection, recursivelly.
fadeOutWithAnim(delay, selectedClass, callback)
Applies a fadeOut animation to every element in a selection, recursivelly.
Coming in next versions
- Refactor code to not requiring jQuery anymore
- Simplify code to make it easier to implement
- Provide pre-made bits of UI elements
Contact and issues/contributing
If you find a bug, or if you are interested on a new feature, you can submit a ticket on Issues tab, I'll be there to read your ideas!
If you want to contact me/contribute those are my contact links
:email: jruanogalvez@gmail.com
I'll be happy to talk to you :smiley: