Git Product home page Git Product logo

spinkit's Introduction

Simple loading spinners animated with CSS. See demo.

SpinKit uses CSS animations to create smooth and easily customizable animations. The goal is not to offer a solution that works in every browser—if you're supporting browsers that haven't implemented the CSS animation property (e.g. IE9 and below), you'll want to detect support for the animation property, and implement a fallback (see below.)

Usage

Regular CSS

Grab the HTML and CSS for a spinner and include it in your project. Note that a hidden spinner (opacity: 0, or visibility: hidden) will still animate. After hiding a spinner, it's recommended to remove it from the DOM, set display: none or pause the animation by setting animation-play-state: paused.

SpinKit can also be installed to your project with bower:

$ bower install spinkit

SCSS

If you're using SCSS in your project then you can include just the styles for the spinners that you want by adding the following to your main file:

@import '../bower_components/spinkit/scss/spinners/1-rotating-plane',
        '../bower_components/spinkit/scss/spinners/3-wave';

Please note that you currently need to use autoprefixer in your project if you want to support all browsers. If you're compiling your SCSS with gulp you can use gulp-autoprefixer or if you use grunt then grunt-autoprefixer is a good choice.

There are some variables that can be overridden if you use SCSS. The defaults are listed in scss/_variables.scss.

Old web browser compatibility

With support for CSS animations in every current browser and almost 90% of all browsers in use today, the need for GIF and JavaScript fallbacks is decreasing quickly. If you still need to support those last few then this section is for you.

Implementing a fallback spinner

An easy way to provide a fallback animation is to check for support for the animation property, and replace the spinner with a GIF if it's not supported.

function browserSupportsCSSProperty(propertyName) {
  var elm = document.createElement('div');
  propertyName = propertyName.toLowerCase();

  if (elm.style[propertyName] != undefined)
    return true;

  var propertyNameCapital = propertyName.charAt(0).toUpperCase() + propertyName.substr(1),
    domPrefixes = 'Webkit Moz ms O'.split(' ');

  for (var i = 0; i < domPrefixes.length; i++) {
    if (elm.style[domPrefixes[i] + propertyNameCapital] != undefined)
      return true;
  }

  return false;
}

Use it to check for animation support:

if (!browserSupportsCSSProperty('animation')) {
  // fallback…
}

Contributing

See CONTRIBUTING.md for details.

spinkit's People

Contributors

tobiasahlin avatar jacobsvante avatar zhanglun avatar ahmadhania avatar fidelix avatar mhm5000 avatar fylax avatar patrickjs avatar

Watchers

Justin Farrow avatar James Cloos avatar

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.