# saber-run

**Repository Path**: mirrors_ecomfe/saber-run

## Basic Information

- **Project Name**: saber-run
- **Description**: 移动端动画效果支持
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

saber-run [![Build Status](https://travis-ci.org/ecomfe/saber-run.png?branch=master)](https://travis-ci.org/ecomfe/saber-run)
===

移动端动画效果支持

## Installation

通过 [edp](https://github.com/ecomfe/edp) 引入模块：

```sh
edp import saber-run
```

## Usage

```js
var runner = require('saber-run');
var ele = document.getElmentById('saber');

var animation = runner.animation(ele);

animation
    // x、y轴各移动10像素
    .move(10, 10)
    // 设置动画时长为700ms
    .duration(0.7)
    // 同时再旋转60度
    .rotate(60)
    // 跑起来～
    .run()
    // 动画完后再干点啥
    .finish(function () {
        alert('Surprise')
    })
    // 再来一次 歪个脖
    .skew(10)
    .run();
```

## API

* [Methods](#methods)
* [Classes](#classes)

### Methods

#### animation(ele[, options])

创建动画对象, 返回[Animation](doc/animation.md)实例

* **ele** `{HTMLElement}` 需要进行动画的DOM元素
* **options** `{Object=}` 默认动画配置参数
    * **duration** `{number=}` 默认动画时长
    * **delay** `{number=}` 默认动画延时
    * **ease** `{string=}` 默认缓动效果
* _return_ `{Animation}` [Animation](doc/animation.md)动画对象

缓动效果如下 参考[move.js](https://github.com/visionmedia/move.js)：

```js
{
    'default': 'ease',
    'in': 'ease-in',
    'out': 'ease-out',
    'in-out': 'ease-in-out',
    'snap': 'cubic-bezier(0,1,.5,1)',
    'linear': 'cubic-bezier(0.250, 0.250, 0.750, 0.750)',
    'ease-in-quad': 'cubic-bezier(0.550, 0.085, 0.680, 0.530)',
    'ease-in-cubic': 'cubic-bezier(0.550, 0.055, 0.675, 0.190)',
    'ease-in-quart': 'cubic-bezier(0.895, 0.030, 0.685, 0.220)',
    'ease-in-quint': 'cubic-bezier(0.755, 0.050, 0.855, 0.060)',
    'ease-in-sine': 'cubic-bezier(0.470, 0.000, 0.745, 0.715)',
    'ease-in-expo': 'cubic-bezier(0.950, 0.050, 0.795, 0.035)',
    'ease-in-circ': 'cubic-bezier(0.600, 0.040, 0.980, 0.335)',
    'ease-in-back': 'cubic-bezier(0.600, -0.280, 0.735, 0.045)',
    'ease-out-quad': 'cubic-bezier(0.250, 0.460, 0.450, 0.940)',
    'ease-out-cubic': 'cubic-bezier(0.215, 0.610, 0.355, 1.000)',
    'ease-out-quart': 'cubic-bezier(0.165, 0.840, 0.440, 1.000)',
    'ease-out-quint': 'cubic-bezier(0.230, 1.000, 0.320, 1.000)',
    'ease-out-sine': 'cubic-bezier(0.390, 0.575, 0.565, 1.000)',
    'ease-out-expo': 'cubic-bezier(0.190, 1.000, 0.220, 1.000)',
    'ease-out-circ': 'cubic-bezier(0.075, 0.820, 0.165, 1.000)',
    'ease-out-back': 'cubic-bezier(0.175, 0.885, 0.320, 1.275)',
    'ease-in-out-quad': 'cubic-bezier(0.455, 0.030, 0.515, 0.955)',
    'ease-in-out-cubic': 'cubic-bezier(0.645, 0.045, 0.355, 1.000)',
    'ease-in-out-quart': 'cubic-bezier(0.770, 0.000, 0.175, 1.000)',
    'ease-in-out-quint': 'cubic-bezier(0.860, 0.000, 0.070, 1.000)',
    'ease-in-out-sine': 'cubic-bezier(0.445, 0.050, 0.550, 0.950)',
    'ease-in-out-expo': 'cubic-bezier(1.000, 0.000, 0.000, 1.000)',
    'ease-in-out-circ': 'cubic-bezier(0.785, 0.135, 0.150, 0.860)',
    'ease-in-out-back': 'cubic-bezier(0.680, -0.550, 0.265, 1.550)'
}
```

#### transition(ele, properties, options)

设置元素transition效果

* **ele** `{HTMLElement}` DOM元素
* **properties** `{Object}` 变化的样式属性
* **options** `{Object=}` 配置参数
    * **duration** `{number=}` 时长
    * **delay** `{number=}` 延时
    * **ease** `{string=}` 缓动效果
* _return_ `{Promise}` 表示transition结果的[Promise](https://github.com/ecomfe/saber-promise)对象

#### stopTransition(ele)

停止元素的transition效果，所有属性立即变为最终值

* **ele** `{HTMLElement}` DOM元素

#### onTransitionEnd(ele, callback[, useCapture])

监听transitionend事件

* **ele** `{HTMLElement}` DOM元素
* **callback** `{Function}` 回调函数
* **useCapture** `{boolean=}` 是否启用捕获，默认为`false`

#### unTransitionEnd(ele, callback[, useCapture])

取消监听transitionend事件

* **ele** `{HTMLElement}` DOM元素
* **callback** `{Function}` 回调函数
* **useCapture** `{boolean}` 是否启用捕获，默认为`false`

#### oneTransitionEnd(ele, callback[, useCapture])

只监听一次transitionend事件

* **ele** `{HTMLElement}` DOM元素
* **callback** `{Function}` 回调函数
* **useCapture** `{boolean}` 是否启用捕获，默认为`false`

#### requestAnimationFrame(callback)

添加动画帧

* **callback** `{Function}` 回调函数
* _return_ `{number}` 动画帧标示

#### cancelAnimationFrame(idenity)

取消已添加的动画帧

* **idenity** `{number}` 动画帧标示，由[requestAnimationFrame()](#requestanimationframecallback)返回

### Classes

* [Animation](doc/animation.md) 动画对象