Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daybrush/keyframer
Make the CSS Keyframes the keyframes object.
https://github.com/daybrush/keyframer
css keyframes scenejs
Last synced: 2 months ago
JSON representation
Make the CSS Keyframes the keyframes object.
- Host: GitHub
- URL: https://github.com/daybrush/keyframer
- Owner: daybrush
- License: mit
- Created: 2019-05-13T15:01:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-21T17:37:27.000Z (over 1 year ago)
- Last Synced: 2024-10-06T10:38:32.419Z (3 months ago)
- Topics: css, keyframes, scenejs
- Language: TypeScript
- Homepage:
- Size: 368 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# keyframer [](https://badge.fury.io/js/keyframer)
Make the CSS Keyframes the keyframes object.
## Installation
### npm
```bash
$ npm install keyframer
```
### scripts
* Unpackaged (dependency in [**scenejs**](https://github.com/daybrush/scenejs))
```html
```
* Packaged
```html
```
## Getting Started
```html
@keyframes keyframes {
0% {
opacity: 1;
transform: translate(0px, 0px) rotate(0deg);
}
50% {
opacity: 0;
transform: translate(50px, 0px) rotate(0deg);
}
100% {
opacity: 1;
transform: translate(100px, 0px) rotate(50deg);
}
}
```
### Get the keyframes object
```js
import { getKeyframes, getKeyframesObject } from "keyframer";
/*
{
"0%": "opacity: 1; transform: translate(0px, 0px) rotate(0deg)",
"50%": "opacity: 0; transform: translate(50px, 0px) rotate(0deg)",
"100%": "opacity: 1; transform: translate(100px, 0px) rotate(50deg)",
}
*/
// Keyframer.getKeyframes("keyframes")
const obj = getKeyframes("keyframes");
/*
{
"0%": {
opacity: 1,
transform: { translate: "0px,0px", rotate: "0deg" },
}
"50%": {
opacity: 0,
transform: { translate: "50px,0px", rotate: "0deg" },
},
"100%": {
opacity: 1,
transform: { translate: "100px,0px", rotate: "50deg" },
},
}
*/
// Keyframer.getKeyframesObject("keyframes")
const obj = getKeyframesObject("keyframes");
```
### Play the CSS Keyframes with [scenejs](https://github.com/daybrush/scenejs)
```js
import { SceneItem } from "scenejs";
import { getKeyframes, getKeyframesObject } from "keyframer";
new SceneItem(getKeyframes("keyframes"))
.setDuration(1)
.setSelector("[data-keyframer] .rect")
.play();
```
## API Documents
* [API Documentation](https://daybrush.com/keyframer/release/latest/doc/)
* [API Features Documentation](https://daybrush.com/scenejs/features.html#keyframer)
```
MIT License
Copyright (c) 2019 Daybrush
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.
```