JSPM

@infinityfx/lively

2.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 71
  • Score
    100M100P100Q76973F
  • License GPL-3.0

Feature complete, lightweight react animation library.

Package Exports

  • @infinityfx/lively
  • @infinityfx/lively/animations
  • @infinityfx/lively/auto
  • @infinityfx/lively/hooks

Readme

Lively

NPM package NPM bundle size Last commit NPM weekly downloads NPM downloads

Feature complete, lightweight react animation library. Lively lets u create performant animations without the hassle.

Table of contents

Get started

Installation

$ npm i @infinityfx/lively

Usage

import { Animate } from '@infinityfx/lively';

...

<Animate onMount>
    <div class="my-class">
        Lorem ipsum enim amet consequat ut reprehenderit cupidatat et incididunt qui minim culpa. Dolor do laborum nulla pariatur tempor excepteur duis et ipsum.
    </div>
</Animate>

Base components

Animatable <Animatable />

Base animation component that allows for fully customizable animations.

import { Animatable } from '@infinityfx/lively';

...

<Animatable
    onMount
    initial={{ opacity: 0 }}
    animate={{ opacity: 1 }}>
    <div>...</div>
</Animatable>

Animate <Animate />

Fully automatic animation based on pre-fab animations.

import { Animate } from '@infinityfx/lively';
import { Scale, Fade } from '@infinityfx/lively/animations';

...

<Animate onMount animations={[Scale({ duration: 2 }), Fade]}>
    <div class="my-class">
        ...
    </div>
</Animate>

Reactivity

Lively implements fully reactive animations using the useLink() and useScroll() hooks.

Auto-animation

LayoutGroup <LayoutGroup />

Animates <Animatable /> and <Morph /> components, that are direct children when their layout changes.

import { Animatable } from '@infinityfx/lively';
import { LayoutGroup } from '@infinityfx/lively/auto';

...

<LayoutGroup>
    <Animatable>
        <div class="my-class">
            Hello world!
        </div>
    </Animatable>
</LayoutGroup>

Morph <Morph />

Morphs one element into another.

import { Morph } from '@infinityfx/lively/auto';

...

<Morph active={state}>
    <div onClick={() => setState(!state)}>
        ...
    </div>
</Morph>

<Morph active={!state}>
    <div onClick={() => setState(!state)}>
        ...
    </div>
</Morph>

Parallax <Parallax />

Easily create parallax motion based on page scroll position.

import { Parallax } from '@infinityfx/lively/auto';

...

<Parallax amount={0.5}> // default amount = 0.5
    <div class="my-class">
        ...
    </div>
</Parallax>

WriteOn <WriteOn />

import { WriteOn } from '@infinityfx/lively/auto';

...

<WriteOn>Lorem ipsum dolor sit amet</WriteOn>

ColorWipe <ColorWipe />

import { ColorWipe } from '@infinityfx/lively/auto';

...

<ColorWipe>
    <div class="my-class">...</div>
</ColorWipe>

Animations

Overview

Lively exports a submodule called animations which contains various pre-fab animations that can be used in tandem with the <Animate /> and <Animatable /> components. These animations can be used as is, or can be configured with extra options by calling the respective animation as a function which takes as an argument the options object.

import { Move } from '@infinityfx/lively/animations';

// configure the animation
Move({ direction: 'down' }); // default = 'up'

These pre-fab can be used as followed with either an <Animate /> or <Animatable /> component:

import { Move } from '@infinityfx/lively/animations';
import { Animate } from '@infinityfx/lively/auto';

...

<Animate animations={[Move, Move({ ... })]}>...</Animate>
import { Move } from '@infinityfx/lively/animations';
import { Animatable } from '@infinityfx/lively';

...

<Animatable animations={{
    myAnimationName: Move,
    myOtherAnimation: Move({ ... })
}}>...</Animatable>

// or

<Animatable animate={Move}>...</Animatable>

Create your own

If you whish to create your own pre-fab animation, you can do so using the .create() method of the Animation class. This method takes a function which gets the animation configuration options passed as an argument. The function must return the animation properties/keyframes.

import { Animation } from '@infinityfx/lively/animations';

const myCustomAnimation = Animation.create((options) => {

    // do whatever you want here.

    // This function must return an Array with 2 Objects, containing the animation properties and/or keyframes and the initial values for the animation respectively.
    return [{ ... }, { ... }];
});

export default myCustomAnimation;

Hooks

Lively comes with a set of hooks that allow for the creation of complex reactive animations.

useUnmount()

The useUnmount hook can be used to animate out components that are being unmounted. It can be used in tandem with the <Animatable /> and <Animate /> components.

import { useUnmount } from '@infinityfx/lively/hooks';
import { Animatable } from '@infinityfx/lively';

export default function Page() {

    const [mounted, setMounted, ref] = useUnmount(true /* initial mounted value */);

    return mounted &&
        <Animatable ref={ref} onMount onUnmount>...</Animatable>;

}

The useLink hook can be used to create a reactive value, which can be linked to animation components to animate different properties based on the value.

import { useEffect } from 'react';
import { useLink } from '@infinityfx/lively/hooks';
import { Animatable } from '@infinityfx/lively';

export default function Page() {

    const [link, setValue] = useLink(0 /* initial value */);

    useEffect(() => {
        setTimeout(() => setValue(1), 1000); // set the animation value to 1, 1 second after the component has mounted.
    }, []);

    return <Animatable animate={{
        opacity: link
    }}>...</Animatable>;

}

Additionally you can provide a link with a function to transform the value to a more usable format for certain animation properties.

const [link, setValue] = useLink(0 /* initial value */);

return <Animatable animate={{
    position: link(input => {
        input /= 100; // example where the input value needs to be divided for the correct output format.

        return { x: input, y: input }; // we return an object instead of a number for the position property.
    })
}}>...</Animatable>;

useScroll()

The useScroll hook is an extension of the useLink hook which returns a reactive value that corresponds to the current scroll position of the window.

const value = useScroll();

// gradually fade in element when scrolling the window
return <Animatable animate={{
    opacity: value(val => val / document.body.scrollHeight)
}}>...</Animatable>;

usePath()

The usePath hook can be used to animate an element along an SVG path.

const [link, ref] = usePath([100, 0], 2); // offset the path by 100px along the x-axis and scale it up by a factor of 2.

return <>
    <Animatable animate={{
        translate: link
    }}>...</Animatable>

    <svg>
        <path ref={ref} d="..." /> {/* Some svg path to reference */}
    </svg>
</>;

useReducedMotion()

The useReducedMotion hook checks whether a user prefers the use of reduced motion on a page.

const reduced = useReducedMotion();

// If the user prefers reduced motion, then pause the animation.
return <Animatable animate={{ ... }} paused={reduced}>...</Animatable>;