sequin-js

0.0.2 • Public • Published

Sequin.js

Install Sequin.js via npm: npm install sequin-js

Sequin allows you to create animations easily using CSS classes. Transition durations are set automatically and all you need to concern yourself with is how each state differs via your classes.

Example

Since Sequin's syntax reads like a book, a good example of how to use it is through the syntax itself.

  • Element by class to interact with: sequin.with('first');
  • Add/remove the following classes: .add('pink');
  • After 500 milliseconds: .after(500);
  • Finish animation in 750 milliseconds: .within(750);
  • Run the animation process: .run();

Put all together using Sequin's method chaining, you end up with:

sequin.with('first').add('pink').after(500).within(750).run();

Multiple Elements

Whilst the simplest way to configure Sequin is by using individual nodes, it also supports concurrent animations. Each and every method accepts an array of values as well.

sequin  .with(['first', 'second'].add(['red', 'blue']).after([500, 1000])
        .within([1000, 2000]).run();

Extrapolation

You can even omit values and the last value will be used. If for instance you wanted to apply the class orange to five separate elements, there's no need to specify the class name six times.

sequin.with(['first', 'second', 'third', 'fourth', 'fifth']).add('orange');

Sequential

Sequin also supports the concept of the promise pattern style then.

sequin  .with('first').add('blue').after(250).within(100)
        .then()
        .with('first').remove('blue').after(250).within(4000)
        .run();

Whereby the above adds the class name blue to the first element quickly, and then slowly removes the class afterwards.

It's worth noting that after values are relative to its predecessor. Therefore in the above example, the second animation would happen 250 milliseconds after the first one completed.

  • First animation begins after 250 milliseconds;
  • Second animation occurs 250 milliseconds afterwards (500ms from start to end, excluding transitions);

If you didn't want the second animation to start before the blue had been completely applied, then your second animation should take place after 350 milliseconds (after(250) + within(100)).

Readme

Keywords

none

Package Sidebar

Install

npm i sequin-js

Weekly Downloads

1

Version

0.0.2

License

BSD-2-Clause

Last publish

Collaborators

  • wildhoney