Skip to content

Latest commit

 

History

History
164 lines (112 loc) · 6.73 KB

README.md

File metadata and controls

164 lines (112 loc) · 6.73 KB
Raw

#hover.css

A collection of CSS3 powered hover effects to be applied to call to actions, buttons, logos, featured images and so on. Easily apply to your own elements, modify or just use for inspiration. Available in CSS and SASS.

##Demo and Tutorial

Demo | Tutorial

##How To Use hover.css can be used in a number of ways; either copy and paste the effect you'd like to use in your own stylesheet or reference the stylesheet. Then just add the class name of the effect to the element you'd like it applied to.

###Copy and Paste an Effect If you plan on only using one or several effects, it's better practice to copy and paste an effect into your own stylesheet, so a user doesn't have to download hover.css in its entirety.

Assuming you want to use the Grow effect:

  1. Download hover.css
  2. In hover.css, find the 'Grow' CSS (each effect is named using a comment above it):
/* Grow */

.grow {
  display: inline-block;
  -webkit-transition-duration: 0.3s;
  transition-duration: 0.3s;
  -webkit-transition-property: -webkit-transform;
  transition-property: transform;
  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
  -webkit-transform: translateZ(0);
  -ms-transform: translateZ(0);
  transform: translateZ(0);
  box-shadow: 0 0 1px rgba(0, 0, 0, 0);
}

.grow:hover {
  -webkit-transform: scale(1.1);
  -ms-transform: scale(1.1);
  transform: scale(1.1);
}
  1. Copy this effect and then paste it into your own stylesheet.
  2. In the HTML file which you'd like the effect to appear, add the class of .grow to your chosen element.

Example element before applying hover.css effect:

<a class="button">Add to Basket</a>

Example element after applying hover.css effect:

<a class="button grow">Add to Basket</a>

###Reference hover.css If you plan on using many of hover.css' effects on your website, you may like to reference the entire hover.css stylesheet.

  1. Download hover-min.css
  2. Add hover-min.css to your websites files, in a directory named css for example
  3. Reference hover-min.css in <head> of the HTML page you'd like to add hover.css effects to:
<head>
	<link href="css/hover-min.css" rel="stylesheet">
</head>
  1. Assuming you want to use the 'Grow' effect, in the HTML file you'd like to use this effect, add the class of .grow to your chosen element.

Example element before applying hover.css effect:

<a class="button">Add to Basket</a>

Example element after applying hover.css effect:

<a class="button grow">Add to Basket</a>

##Browser Support Many of hover.css' effects rely on CSS3 features such as transitions, animations, transforms and pseudo-elements, for that reason, effects may not fully work in older browsers.

Aside from the above mentioned browsers, hover.css is supported across all major browsers. Please see caniuse.com for full support for many web technologies and test your webpages accordingly.

##Using Grunt for Development

Grunt is non-essential but can speed up development. With Grunt installed, run grunt from the command line to set up a development server accessed at http://127.0.0.1:8000/. With Grunt running, SASS will be preprocessed and CSS files will be minified.

Note that originally Grunt was set up to autoprefix CSS properties but to make the project as accessible as possible, this is no longer the case. The prefixed(property, value) SASS mixin should be used for browser prefixing instead. See Using SASS for Development.

##Using SASS for Development

SASS is non-essential but can speed up development. Preprocess SASS with your favourite software or the environment provided via Grunt.

SASS is used in the Hover.css project to separate various CSS into specific files. Each effect is within its own file in the effects directory. Hover.css also uses the following .scss files:

###_hacks.scss Contains some hacks applied to certain effects. Hacks explained here.

###_mixins.scss Contains the default button style used on the example page, and prefixed(property, value) and keyframes(keyframe-name) mixins that apply the necessary prefixes you specify in _options.scss to properties and keyframes.

prefixed(property, value) can be used like so:

@include prefixed(transition-duration, .3s);

The prefixed(property, value) mixin is passed the property you want to prefix, followed by its value.

keyframes(keyframe-name) can be used like so:

@include keyframes(my-animation) {
  to {
    color: red;
  }
}

The keyframes(keyframe-name) mixin is passed the keyframe name, followed by the content of your keyframe within parenthesis {}.

###_options.scss Contains default options, various effect options and the browser prefixes you'd like to use with the prefixed() mixin. By default, only the -webkit- prefix is set to true (due to most browsers not requiring prefixes now).

##Authors

##License hover.css is open source, and made available under a MIT License. Distribute, use as-is, or modify to your liking in personal and commercial projects. Please retain the original readme and license files.

Placing author information in your stylesheet, credits page or humans.txt is much appreciated.

##Support Future Development

To support the future development of Hover.css and other open source projects created by Ian Lunn, please consider making a donation.

Your donation is not-for-profit (or beer!), and will allow Ian to spend a little less time on client projects and more time supporting and creating open source software.

Thank you.

Bitcoin:

Bitcoin donations may be sent to the following address:

1KEbFvcXL8m6LogG2wjSUFz2xH6PeN6jRd