rofrischmann/fela

View on GitHub
website/docs/11.7.0/basics/keyframes.mdx

Summary

Maintainability
Test Coverage
# Keyframes

As the name already suggests, keyframes are used to render [CSS animation keyframes](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Animations/Using_CSS_animations).

Keyframes are very similar to rules, in that they are also defined as functions of `props` and return objects, but the returned objects have a slightly different shape.

## Keyframe Object

The objects returned by keyframes are called _keyframe objects_ if they conform a special shape.<br />Each key in the object must be either a percentage value or the keywords `from` or `to`, which are equivalent to `0%` and `100%`. Those keys again need to reference objects containing all style declarations that should be animated. The nested objects have to conform to a [rule](basics/rules)'s [basic shape](basics/rules#basic-shape).

```javascript
const keyframe = (props) => ({
  '0%': { color: 'black' },
  '33%': { color: props.firstColor },
  '66%': { color: props.secondColor },
  '100%': { color: 'black' },
})
```

---

## Related

- [Rendering Keyframes](basics/renderer#renderkeyframe)
- [API Reference - `Renderer.renderKeyframe` ](api/fela/renderer#renderkeyframe)

### Tools

**[FormidableLabs/react-animations](https://github.com/FormidableLabs/react-animations)**<br />
CSS animations to be used with CSS in JS solutions<br />