Repository: tobiasahlin/SpinKit
Branch: master
Commit: 742a71277c49
Files: 8
Total size: 26.8 KB
Directory structure:
gitextract_dx25p364/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bower.json
├── examples.html
├── package.json
└── spinkit.css
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
node_modules/
.DS_Store
*.sublime-project
*.sublime-workspace
================================================
FILE: CHANGELOG.md
================================================
# 2.0.1
* Fixed: Chase spinner's HTML snippet now has the correct number of children
# 2.0.0
* New: Added examples.html, with an overview of all spinners
* New: Added a brand new chase spinner
* New: Added spinkit.min.css
* Fixed: `inline-block` is no longed used to position any spinners (decoupling spacing from any potential font effects)
* Changed: Most spinners now have more distinct and shorter names
* Changed: No positioning is now applied by default on any of the spinners (center the spinner with the utility class `sk-center`)
* Changed: All elements now only have one single class
* Changed: No more dependencies. gulp, npm, node, etc. is not required to build this project. There's nothing to build
* Changed: No more SCSS. All configuration is now done through CSS vars
* Fixed: All keyframe animations are now named after the elements/classes that are using them
# 1.2.5
* Fixed: Add folding cube spinner (11) to combined CSS file
# 1.2.4
* Fixed: Borked gulp script (#106)
* Fixed: Moved changes made in CSS, to SCSS
# 1.2.3
* Fixed: More exact (33% -> 33.33%) cube dimensions for cube grid spinner
* Fixed: Comment format for HTML inside CSS, for easier copy and pasting (removed * at the beginning of each row)
# 1.2.2
* Fixed: Use variable for spinner size (defaults to 40px)
# 1.2.1
* Fixed: Two spinners were slightly broken on Android
* Changed: Bumped default top and bottom margin to 40px
# 1.2.0
* Added: Folding cube spinner
* Fixed: Lowercase in package name
# 1.1.0
* Removed one spinner (circle with rotating circle, not polished enough)
* Cleaned up the CSS
* Added more SCSS variables to more easily customize spinners
* Introduced SCSS `@for` loops to more easily change timing of spinners
* Removed moot `version` property from bower.json
# 1.0.1
* Fix: Missed sass variables for background-color
================================================
FILE: LICENSE
================================================
The MIT License (MIT)
Copyright (c) 2020 Tobias Ahlin
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: README.md
================================================
# [SpinKit](http://tobiasahlin.com/spinkit/)
Simple loading spinners animated with CSS. See [demo](http://tobiasahlin.com/spinkit/). SpinKit only uses (`transform` and `opacity`) CSS animations to create smooth and easily customizable animations.
## Usage
- Add `spinkit.css` or `spinkit.min.css` to your project (or copy-paste the CSS that you need for your spinner—there are no dependencies between spinners, no shared classes, and no shared animations, etc, so it should be fairly straight-forward to extract only the code that you need)
- Add a spinner to your project by copy-pasting HTML from `spinkit.css` or `examples.html`
- Add the `sk-center` utility class to the spinner to center it (it sets `margin` to `auto`)
- By default, the `width` and `height` of all spinners are set to `40px`. `background-color` is set to `#333`.
- Configure the spinner by overwriting the CSS variables, primarily `--sk-size` (spinner width & height) and `--sk-color` (spinner color). If you need broader browser support, remove the CSS variables.
You can include SpinKit to your project with `bower`:
```bash
$ bower install spinkit
```
or npm:
```bash
$ npm install spinkit
```
## Spinners
Given that you have included `spinkit.min.css` in your project, these snippets will produce the different spinners:
### Plane
```html
```
### Chase
```html
```
### Bounce
```html
```
### Wave
```html
```
### Pulse
```html
```
### Flow
```html
```
### Swing
```html
```
### Circle
```html
```
### Circle Fade
```html
```
### Grid
```html
```
### Fold
```html
```
### Wander
```html
```
## Web browser compatibility
SpinKit uses CSS animations and variables:
- CSS keyframes animations [are at +96.5% global support](http://caniuse.com/#feat=css-animation)
- CSS variables [are at +91.8% global support](https://caniuse.com/#feat=css-variables)
### Implementing a fallback spinner
How do you know if you need to provide a fallback? You can check for animation support with [Modernizr](http://modernizr.com), or manually check for the `animation` property, and replace the spinner with a GIF if it's not supported:
```javascript
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:
```javascript
if (!browserSupportsCSSProperty('animation')) {
// fallback…
}
```
================================================
FILE: bower.json
================================================
{
"name": "SpinKit",
"homepage": "https://github.com/tobiasahlin/SpinKit",
"authors": [
"Tobias Ahlin"
],
"description": "A collection of loading indicators animated with CSS",
"main": "css/spinkit.css",
"keywords": [
"css",
"scss",
"web"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules"
]
}
================================================
FILE: examples.html
================================================
SpinKit Examples