FlandreScarle7/font-awesome-animation
1
0
Fork 0
mirror of https://github.com/l-lin/font-awesome-animation.git synced 2024-12-26 21:41:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Simple animations using FontAwesome and some CSS3.
85 Commits 1 Branch 19 Tags 3.3 MiB
CSS 54.3%
SCSS 42.7%
JavaScript 3%
82493ce04f
Go to file
Louis Lin 82493ce04f doc: add usage
2021-01-22 21:52:01 +01:00
.github/workflows build: remove publishing to Github package 2021-01-22 10:28:51 +01:00
css refactor: switch node-sass from Myth + use SCSS instead to generate CSS 2021-01-22 21:11:12 +01:00
scripts refactor: switch node-sass from Myth + use SCSS instead to generate CSS 2021-01-22 21:11:12 +01:00
scss refactor: switch node-sass from Myth + use SCSS instead to generate CSS 2021-01-22 21:11:12 +01:00
_config.yml Set theme jekyll-theme-midnight 2021-01-22 21:21:40 +01:00
.editorconfig build: change CI 2021-01-21 20:25:02 +01:00
.gitignore build: add release workflow 2021-01-22 10:02:23 +01:00
LICENSE doc: update LICENSE dates 2021-01-21 12:42:49 +01:00
package-lock.json refactor: switch node-sass from Myth + use SCSS instead to generate CSS 2021-01-22 21:11:12 +01:00
package.json refactor: switch node-sass from Myth + use SCSS instead to generate CSS 2021-01-22 21:11:12 +01:00
README.md doc: add usage 2021-01-22 21:52:01 +01:00

README.md

font-awesome-animation

Simple animations using some CSS3 I found on the web. Best used on glyphicons like FontAwesome

build npm npm jsdelivr

Getting started

Install from NPM:

npm install font-awesome-animation

Or with a CDN:

https://www.jsdelivr.com/package/npm/font-awesome-animation

Include CSS file in your index.html file:

<link rel="stylesheet" href="font-awesome-animation.min.css">

Usage

On DOM load

Add the desired CSS class faa-xxx along with animated to the icon (or any element of your DOM):

<i class="fa fa-wrench faa-wrench animated"></i>

On hover

Instead of using animated, use the animated-hover CSS class:

<i class="fa fa-wrench faa-wrench animated-hover"></i>

On parent element hover

For parent hover, add the CSS class faa-parent and animated-hover on the parent element:

<a href="#" class="faa-parent animated-hover">
  <i class="fa fa-wrench faa-wrench"></i>
</a>

You can regulate the speed of the animation by adding the CSS class faa-fast or faa-slow:

<i class="fa fa-wrench faa-wrench animated faa-fast"></i>
<i class="fa fa-wrench faa-wrench animated faa-slow"></i>

Development

# install dependencies
npm install

# generate prefixes and minified CSS files
npm run build

License

MIT License