# bin-animation

**Repository Path**: wangbin3162/bin-animation

## Basic Information

- **Project Name**: bin-animation
- **Description**: 基于vue，结合transition钩子函数配合的css3动画库
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://wangbin3162.gitee.io/bin-animation/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-13
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bin-animation

[document](https://wangbin3162.gitee.io/bin-animation/)

bin-animation是一个关键帧动画库，结合vue transition组件的钩子函数，我们可以快速的实现复杂的动画效果。
您可以使用js再浏览器中动态的生成css关键帧动画。并插入一个 style 标签中,这允许您根据位置动态的计算值，并允许您实际高效地运行动画，
而无需处理或运行requestAnimationFrame来进行动画渲染。

而且好处是，您不需要预先编写固定的css关键帧，js主线程中动态添加也会让你灵活运用，动态的去创建复杂的动画并进行组合调用。

通常CSS动画是在一个单独的CSS样式表中声明的，就像这样:

```
@keyframes move {
  0% {
    transform: translate3d(0,0,0)
  }
  100% {
    transform:translate3d(100px,0,0)
  }
}
```

这表示会将当前元素往x轴方向移动100px，
如果您想运行时动态地更改这些固定像素值，那么您将无法预先编写css动画，并且会很难实现。

我想要做的是

```javascript
import animations from 'bin-animation'

// 这就创建了上面的动画
animations.create({
  name: 'move',
  // 实际是animation数组（对象）发生了动画
  animation: [
	[0,0], 
	[100,0]
  ],
  // presets可选预置，实际运行动画时会配置的参数
  presets: {
    duration: 1000,
    easing: 'linear',
    delay: 500
  }
})
// 运行动画
animations.run(el, 'move', function () {
	// 动画完成后调用事件
})
// 如果支持promise则支持链式调用
animations.run(el, 'moveUp')
	.then(function () {
		return animations(el, 'wiggle')
	})
	.then(function () {
		console.log('done!')
	})
	.catch(function (err) {
		console.error(err)
	})
```

## 快速上手

根据介绍我们可以快速熟悉动画库的基本构成，这部分讲讲如何快速了解我们的基础api

### 安装

```shell
npm i bin-animation -S
# or 
yarn add bin-animation
```

### Base API

通过这种方式导入我们的动画库我们可以任意起名字如animations，以下默认都是animations

```
import animations from 'bin-animation'
```

#### 1.create(opts)

创建动画opts配置参数

| 参数名 | 说明 | 类型 | 默认值 |
|---------|---------|---------|---------|
| name  | 动画的名称,是动画所必须的| string | 无 |
| animation   | 动画的关键帧，具体参数可参考下方配置 | object/array | 无 |

如果你给出的animation参数是一个对象，则需要指出关键帧

```javascript

animations.create({
	name: 'move',
	animation: {
		0: [0, 0],
		100: [100, 0]
	}
})

animations.create({
	name: 'move',
	animation: {
		'0%': [0, 0],
		'100%': [100, 0]
	}
})

animations.create({
	name: 'move',
	// 如果你给的是一个数组，则关键帧为动态计算
	animation: [[0, 0], [1, 1]]
})
```

移动的位置这里设置为像素，切默认会开启translate3d来进行gpu加速

其他选项及其默认值

```
{
  duration: 1000, // 默认持续时间，毫秒单位
  fillMode: 'both', // css动画填充模式属性
  easing: 'ease', // 默认的动画曲线
  iterations: 1, // 默认执行一次
  delay: 0, // 默认延迟，毫秒单位
  direction: 'normal', // 动画顺序，默认
  resetWhenDone: false, // 如果为真，则将最终动画状态应用为“transform”属性
  clearTransformsBeforeStart: false // 是否在动画开始之前清除现有的transform
}
```

easing 动画曲线默认是ease，其中可配置

    linear	动画从头到尾的速度是相同的。
    ease	默认。动画以低速开始，然后加快，在结束前变慢。
    ease-in	动画以低速开始。	
    ease-out	动画以低速结束。	
    ease-in-out	动画以低速开始和结束。
    cubic-bezier(n,n,n,n)	在 cubic-bezier 函数中自己的值。可能的值是从 0 到 1 的数值。


#### 2.run(element(s), name string or options object, [callback])

| 参数名 | 说明 | 类型 | 默认值 |
|---------|---------|---------|---------|
| element(s)  | 实际的dom节点或要对其应用动画的节点,可以是单个的也可以是querySelectorAll | el | 无 |
| options   | 如果是name则是注册的动画，如果是一个对象则必须类似create一样传入一个动画名称name | String/Object | 无 |
| callback   | 回调函数，动画执行完毕后操作 | function | 无 |

如果你创建了一个动画预制,你可以很容易地运行它

```javascript
animations.run(el, 'move')
```

如果你传入了一个动画对象，则必须包含一个name属性

```javascript
animations.run(el, {
	name: 'move',
	delay: 1500 // 这里你可以任意覆盖上述的默认选项
}, function () {
	console.log('done!')
})
```

#### 3.remove(name)

删除创建的动画预制，传入动画名称则会去缓存中查询是否创建了动画预制，如包含则会删除它。

**主要即包含了以上3个动画api，具体使用参考演示案例，这里推荐先注册后运行的方式可以方便进行复杂动画的管理，并且在配置创建
预制动画的时候推荐进行全量配置（即对象的方式设置关键帧，可以省略计算的步骤），使得代码更加清晰灵活可读性增强，具体参考演示代码。**