Skip to content
This repository has been archived by the owner on Jun 23, 2023. It is now read-only.

Commit

Permalink
v5.2.0 release
Browse files Browse the repository at this point in the history
a lot of changes, will log inside release note on GitHUb
  • Loading branch information
dalisoft committed Apr 11, 2018
1 parent cf7788e commit 0a148aa
Show file tree
Hide file tree
Showing 25 changed files with 10,232 additions and 19,675 deletions.
176 changes: 0 additions & 176 deletions .eslintrc

This file was deleted.

73 changes: 42 additions & 31 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ Lightweight, effecient and modular ES6 version of tween.js
**Copyright**: 2017 @dalisoft and es6-tween contributors
**Example**
```js
// ES6const {add, remove, isRunning, autoPlay} = TWEEN
// ES6
const {add, remove, isRunning, autoPlay} = TWEEN
```

* [TWEEN](#TWEEN) : <code>object</code>
* [.now](#TWEEN.now)
* [.Plugins](#TWEEN.Plugins) : <code>object</code>
* [.Easing](#TWEEN.Easing) : <code>object</code>
* [.Interpolation](#TWEEN.Interpolation) : <code>object</code>
* [.Interpolator](#TWEEN.Interpolator) ⇒ <code>function</code>
Expand Down Expand Up @@ -43,6 +42,8 @@ Lightweight, effecient and modular ES6 version of tween.js
* [.Tween#easing(_easingFunction)](#TWEEN.Tween.Tween+easing)
* [.Tween#interpolation(_interpolationFunction)](#TWEEN.Tween.Tween+interpolation)
* [.Tween#update(time, [preserve], [forceTime])](#TWEEN.Tween.Tween+update)
* [.Plugins](#TWEEN.Plugins) : <code>object</code>
* [.now](#TWEEN.now)
* [.add(tween)](#TWEEN.add)
* [.onTick(fn)](#TWEEN.onTick)
* [.FrameThrottle([frameCount])](#TWEEN.FrameThrottle)
Expand All @@ -54,27 +55,6 @@ Lightweight, effecient and modular ES6 version of tween.js
* [.update([time], [preserve])](#TWEEN.update)
* [.isRunning()](#TWEEN.isRunning) ⇒ <code>Boolean</code>

<a name="TWEEN.now"></a>

### TWEEN.now ⇒
Get browser/Node.js current time-stamp

**Kind**: static property of [<code>TWEEN</code>](#TWEEN)
**Returns**: Normalised current time-stamp in milliseconds
**Example**
```js
TWEEN.now
```
<a name="TWEEN.Plugins"></a>

### TWEEN.Plugins : <code>object</code>
The plugins store object

**Kind**: static namespace of [<code>TWEEN</code>](#TWEEN)
**Example**
```js
let num = Plugins.num = function (node, start, end) {return t => start + (end - start) * t}
```
<a name="TWEEN.Easing"></a>

### TWEEN.Easing : <code>object</code>
Expand All @@ -83,7 +63,9 @@ List of full easings
**Kind**: static namespace of [<code>TWEEN</code>](#TWEEN)
**Example**
```js
import {Tween, Easing} from 'es6-tween'// then set via new Tween({x:0}).to({x:100}, 1000).easing(Easing.Quadratic.InOut).start()
import {Tween, Easing} from 'es6-tween'

// then set via new Tween({x:0}).to({x:100}, 1000).easing(Easing.Quadratic.InOut).start()
```
<a name="TWEEN.Interpolation"></a>

Expand All @@ -93,7 +75,10 @@ List of full Interpolation
**Kind**: static namespace of [<code>TWEEN</code>](#TWEEN)
**Example**
```js
import {Interpolation, Tween} from 'es6-tween'let bezier = Interpolation.Beziernew Tween({x:0}).to({x:[0, 4, 8, 12, 15, 20, 30, 40, 20, 40, 10, 50]}, 1000).interpolation(bezier).start()
import {Interpolation, Tween} from 'es6-tween'

let bezier = Interpolation.Bezier
new Tween({x:0}).to({x:[0, 4, 8, 12, 15, 20, 30, 40, 20, 40, 10, 50]}, 1000).interpolation(bezier).start()
```
<a name="TWEEN.Interpolator"></a>

Expand Down Expand Up @@ -159,9 +144,9 @@ Sets max `event` listener's count to Events system

**Kind**: static method of [<code>Tween</code>](#TWEEN.Tween)

| Param | Type | Description |
| --- | --- | --- |
| count | <code>number</code> | Event listener's count |
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| count | <code>number</code> | <code>15</code> | Event listener's count |

<a name="TWEEN.Tween.Tween+on"></a>

Expand All @@ -178,7 +163,8 @@ Adds `event` to Events system
<a name="TWEEN.Tween.Tween+once"></a>

#### Tween.Tween#once(event, callback)
Adds `event` to Events system.Removes itself after fired once
Adds `event` to Events system.
Removes itself after fired once

**Kind**: static method of [<code>Tween</code>](#TWEEN.Tween)

Expand Down Expand Up @@ -484,6 +470,29 @@ Updates initial object to target value by given `time`
```js
tween.update(100)
```
<a name="TWEEN.Plugins"></a>

### TWEEN.Plugins : <code>object</code>
The plugins store object

**Kind**: static namespace of [<code>TWEEN</code>](#TWEEN)
**Example**
```js
let num = Plugins.num = function (node, start, end) {
return t => start + (end - start) * t
}
```
<a name="TWEEN.now"></a>

### TWEEN.now ⇒
Get browser/Node.js current time-stamp

**Kind**: static constant of [<code>TWEEN</code>](#TWEEN)
**Returns**: Normalised current time-stamp in milliseconds
**Example**
```js
TWEEN.now
```
<a name="TWEEN.add"></a>

### TWEEN.add(tween)
Expand All @@ -497,7 +506,9 @@ Adds tween to list

**Example**
```js
let tween = new Tween({x:0})tween.to({x:200}, 1000)TWEEN.add(tween)
let tween = new Tween({x:0})
tween.to({x:200}, 1000)
TWEEN.add(tween)
```
<a name="TWEEN.onTick"></a>

Expand Down
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,6 @@ Download the [library](https://raw.githubusercontent.com/tweenjs/es6-tween/maste

### More advanced users might want to...

#### Using `grunt`

PR are welcome...

#### Using `gulp`

After package installed, go-to directory and then run:

- if you want build, then `$ gulp`
- if you want watch, then `$ gulp watch`

#### Using `import`

```javascript
Expand All @@ -145,14 +134,12 @@ const { Tween, Easing, autoPlay } = require('es6-tween')
</script>
```

#### Using `npm`, `yarn` or `bower`
#### Using `npm` or `yarn`

```bash
$ yarn add es6-tween
# or
$ npm install es6-tween
# or
$ bower install es6-tween
```

Then include the Tween.js module with the standard node.js `require`:
Expand All @@ -173,9 +160,9 @@ You can run script commands to build modules into single `UMD` compatible file:
#### Using commands

```bash
$ npm run build # builds production files
$ yarn build # builds production files
# or
$ npm run dev # builds and watchs development files
$ yarn dev # builds and watchs development files
```

Then reference the library source:
Expand Down
26 changes: 0 additions & 26 deletions bower.json

This file was deleted.

Loading

0 comments on commit 0a148aa

Please sign in to comment.