Skip to content

t4y3/taxis

Repository files navigation

T:axis

T:axis - Make it easier to manage animations in requestAnimationFrame

Document

Constructor

Syntax

new Taxis([, options]);

Parameters

options: Optional
  • timeline
    Can check your settings in your timeline.
    Useful during development.

    • container
      • Element to insert a Timeline
    • debug
      • A Boolean that, if true, indicates that the time axis can be edited in TImeline.

Example

const taxis = new Taxis({
  timeline: {
    container: document.querySelector('#timeline')
    debug: true
  }
});

timeline

API

add

Syntax

taxis.add(key, duration, [, delay]);
taxis.add(key, duration, [, delay, position]);

Parameters

key

  • Key indicating the time axis

duration

  • Duration of the time axis

delay

  • Amount of delay in milliseconds before the animation should begin.

position

  • Controls the insertion point in the timeline (by default, it’s the end of the timeline).

Example

const taxis = new Taxis();
taxis.add("key#01", 2000);
taxis.add("key#02", 1000, 500);
taxis.add("key#03", 300, 200, 'key#01');

begin

Syntax

taxis.begin();

ticker

Called in the requestAnimationFrame.

Syntax

taxis.ticker(callback);

Parameters

callback: Function

time

  • Elapsed time since begin()

axes

  • Map data of Taxis

Example

const taxis = new Taxis();
taxis.add("key#01", 2000);
taxis.add("key#02", 600);
taxis.add("key#03", 4000);
taxis.ticker((time, axes) => {
  console.log(axes.get("key#01").progress); // 0.0 ~ 1.0
});

Taxis

progress

  • A number between 0.0 and 1.0 indicating the rate of progress

enter

  • A Boolean that, if true, indicating that progress is greater than 0.0.

pass

  • A Boolean that, if true, indicating that progress is equal to 1.0.

About

T:axis - Make it easier to manage animations in requestAnimationFrame

Resources

License

Stars

Watchers

Forks

Packages

No packages published