motion-signals

A wrapper over Motion One, An animation library, built on the Web Animations API for the smallest filesize and the fastest performance. Works with solid-js

npm version npm Twitter Follow

Installation

npm install motion-signals motion

Functions

As of now, motion-signals has 2 Functions that wrap around animate and timeline of motion one respectively

Example usage

Things You could do with useMotionAnimate

useMotionAnimate List Example

useMotionAnimate Counter Example

Things You could do with useMotionTimeline

useMotionTimeline Example Usage

useMotionAnimate

Returns all the properties returned by animate and some helper functions and state

Props returned my animate are null initially

function App() {
    const { play, isFinished, replay } = useMotionAnimate(
        '.listItem',
        { y: -20, opacity: 1 },
        {
            delay: stagger(0.3),
            duration: 0.5,
            easing: [0.22, 0.03, 0.26, 1],
        },
    );

    // Play the animation on mount of the component
    useEffect(() => {
        play();
    }, []);

    return (
        // Replay the animation anytime by calling a function, anywhere
        <div class="App">
            <button disabled={!isFinished} onClick={() => replay()}>
                Replay
            </button>

            <ul class="list">
                <li class="listItem">Item 1</li>
                <li class="listItem">Item 2</li>
                <li class="listItem">Item 3</li>
            </ul>
        </div>
    );
}

Instead of passing strings to select elements, you can also pass a ref 👇

let boxRef;
const { play, isFinished, replay } = useMotionAnimate(
    () => boxRef, // Pass Function that returns the ref
    { y: -20, scale: 1.2 },
    { duration: 1 },
);

return <div ref={boxRef}>BOX</div>;

API

const { play, replay, reset, isFinished, animateInstance } = useMotionAnimate(
    selector,
    keyframes,
    options,
    events,
);

useMotionAnimate returns:

  • play: plays the animation
  • replay: Resets and plays the animation
  • reset: resets the element to its original styling
  • isFinished: is true when animation has finished playing
  • animateInstance: Animation Controls. Refer to motion one docs for more.

useMotionAnimate accepts:

  • selector – The target element, can be string or a ref

  • keyframes – Element will animate from its current style to those defined in the keyframe. Refer to motion’s docs for more.

  • options – Optional parameter. Refer to motion doc’s for the values you could pass to this.

  • events – Pass functions of whatever you want to happen when a event like onFinish happens.

    events usage example

    const { play, isFinished, replay } = useMotionAnimate(
        '.listItem',
        { y: -20, opacity: 1 },
        {
            delay: stagger(0.3),
            duration: 0.5,
        },
        {
            onFinish: () => {
                // Whatever you want to do when animation finishes
            },
        },
    );

useMotionTimeline

Create complex sequences of animations across multiple elements.

returns timelineInstance (Animation Controls) that are returned by timeline and some helper functions and state

Props returned by timeline are null initially

function App() {
    let gifRef;
    const { play, isFinished, replay } = useMotionTimeline(
        [
            // You can use Refs too!
            [() => gifRef, { scale: [0, 1.2], opacity: 1 }],
            ['.heading', { y: [50, 0], opacity: [0, 1] }],
            ['.container p', { opacity: 1 }],
        ],
        { duration: 2 },
    );

    useEffect(() => {
        play();
    }, []);

    return (
        <div class="App">
            <button disabled={!isFinished} onClick={() => replay()}>
                Replay
            </button>

            <div class="container">
                <img ref={gifRef} class="gif" src={Image} alt="mind explosion gif" />
                <div>
                    <h1 class="heading">Tanvesh</h1>
                    <p>@sarve__tanvesh</p>
                </div>
            </div>
        </div>
    );
}

API

const { play, replay, reset, isFinished, timelineInstance } = useMotionTimeline(
    sequence,
    options,
    events,
);

useMotionTimeline returns:

  • play: plays the animation
  • replay: Resets and plays the animation
  • reset: resets the element to its original styling
  • isFinished: is true when animation has finished playing
  • timelineInstance: Animation Controls. Refer to motion one docs for more.

useMotionTimeline accepts:

  • sequencesequence is an array, defines animations with the same settings as the animate function. In the arrays, Element can be either a string or a ref. You can refer to sequence docs for more on this.
  • options – Optional parameter. Refer to motion doc’s for the values you could pass to this.
  • events – Pass functions of whatever you want to happen when a event like onFinish happens. Exactly same as useMotionAnimate’s onFinish.

Local Installation & Contributing

git clone https://github.com/:github-username/motion-signals.git
cd motion-signals
npm install # Installs dependencies for motion-signals
cd examples # React app to test out changes
npm install # Installs dependencies for example app
npm run dev # To run example on localhost:3000

The contributing guidelines along with local setup guide is mentioned in CONTRIBUTING.md

Any Type of feedback is more than welcome! This project is in very early stage and would love to have contributors of any skill/exp level.

You can contact me on my Twitter handle @Sarve___tanvesh