Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mil/keyfram
Modular Sass animation library that makes compsing complex animations simple.
https://github.com/mil/keyfram
animation css design keyframes prototyping sass sass-framework sass-library
Last synced: 2 days ago
JSON representation
Modular Sass animation library that makes compsing complex animations simple.
- Host: GitHub
- URL: https://github.com/mil/keyfram
- Owner: mil
- License: other
- Created: 2018-09-21T18:44:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T04:54:15.000Z (almost 2 years ago)
- Last Synced: 2024-09-21T18:18:25.533Z (5 days ago)
- Topics: animation, css, design, keyframes, prototyping, sass, sass-framework, sass-library
- Language: CSS
- Homepage: http://kf-sass.com
- Size: 320 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Keyfram - Sass Keyframe Animation Library [](https://travis-ci.org/mil/keyfram)
**Keyfram** is a SCSS library which makes composing CSS keyframe-based animations simple.
[](keyfram.milesalan.com)
A single `@import` away; Keyfram lets you define animations in a simple [SCSS map format](http://keyfram.milesalan.com/guide/animation-maps/) and then modify and compose your animations together using a collection of self-explanatory [mixins](http://keyfram.milesalan.com/mixins). Keyfram takes care of the laborious work of translating your animation into CSS keyframes, freeing you up to focus on your animation itself.
You can use Keyfram for creating anything from simple button hovers to intricately timed and sequenced animations spanning over multiple elements (once only thought feasible by using javascript). Install via [NPM](https://www.npmjs.com/package/kf-sass) or get the [single-file import](https://raw.githubusercontent.com/mil/keyfram/master/dist/kf-1.0.0.scss) to get started.
**Live demos available at:**
- [Documentation site](http://keyfram.milesalan.com)
## Overview of Keyfram
- Modular / composition-focused SCSS animation library
- Available as a [single SCSS file](https://raw.githubusercontent.com/mil/keyfram/master/dist/kf-1.0.0.scss) `@import` (no dependencies)
- Great and simple for quickly for creating animations
- Documented through examples at [keyfram.milesalan.com](http://keyfram.milesalan.com)
- Well-thought out design (mixin-composability, animation-map flexibility etc.)
- Small readable source-code & plently of [unit tests](/test)
## Installation & Basic Usage
Grab the [single-file release](https://raw.githubusercontent.com/mil/keyfram/master/dist/kf-1.0.0.scss) or install via NPM:
```bash
npm install --save kf-sass
```
Next, include in your SCSS file:
```scss
@import 'relative/path-to/kf.scss';
```
From here the most basic example would look like:
```scss
.sliding-box {
$animation-map: ('div': ( margin-left: ( 0ms: 0%, 300ms: 30%, 2000ms: 100% ) ));
@include kf($animation-map);
}
```
## Documentation
Learn more at the [documentation site](http://keyfram.milesalan.com).
**Available Mixins:**
| Mixin | Purpose |
| - | - |
| [kf](http://keyfram.milesalan.com/mixins/kf) | Generate animation keyframes from an animation map. |
| [kf-chain](http://keyfram.milesalan.com/mixins/kf-chain) | Run multiple animations in order sequentially |
| [kf-ease](http://keyfram.milesalan.com/mixins/kf-ease) | Apply easing to an animation |
| [kf-lag](http://keyfram.milesalan.com/mixins/kf-lag) | Add lag time at the end of an animation |
| [kf-lead](http://keyfram.milesalan.com/mixins/kf-lead) | Add lead time before the start of an animation |
| [kf-loop](http://keyfram.milesalan.com/mixins/kf-loop) | Loop an animation a given number of times |
| [kf-mirror](http://keyfram.milesalan.com/mixins/kf-mirror) | Run an animation sequentially forward and then in reverse |
| [kf-parallel](http://keyfram.milesalan.com/mixins/kf-parallel) | Run multiple animations in parallel |
| [kf-reverse](http://keyfram.milesalan.com/mixins/kf-reverse) | Run an animation in reverse |
| [kf-sleep](http://keyfram.milesalan.com/mixins/kf-sleep) | Add sleep (do nothing) time to an animation within a kf-chain |
| [kf-stagger](http://keyfram.milesalan.com/mixins/kf-stagger) | Run multiple animations sequentially staggering the start time of each |
| [kf-stretch](http://keyfram.milesalan.com/mixins/kf-stretch) | Stretch an animation's timing values over a given time or by a multiplier|
| [kf-debug](http://keyfram.milesalan.com/mixins/kf-debug) | Visually debug an animation |