react-animate-text

A react component that animates text per word and/or per line.

Installation

$ npm install @moxy/react-animate-text

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

Motivation

Many projects share the necessity of having animated text, so creating a component for that every time is a waste. This component offers a flexible solution to animate text that you can easily integrate and use in your project.

Usage

import React from 'react';
import AnimateText from '@moxy/react-animate-text';

const MyComponent = (props) => (
    <div className="container">
        <AnimateText initialDelay={ 0.5 } wordDelay={ 0.5 }>
            Lorem ipsum dolor sit amet.
        </AnimateText>
    </div>
);

export default MyComponent;

The AnimateText component uses the @moxy/react-split-text to split the text.

To import the stylesheet, one can import it on the project's entry CSS file:

@import "@moxy/react-animate-text/dist/index.css";

Or in the project's entry JavaScript file:

import "@moxy/react-animate-text/dist/index.css";

API

These are the props available in @moxy/react-animate-text.

children

Type: string | Required: true

Text to be split and animated.

separator

Type: string | Required: false | Default: non-breaking space

The pattern describing where each split should occur, just like the one from String.prototype.split().

className

Type: string | Required: false

A className to apply to the container.

visible

Type: boolean | Required: false

By default this component only displays the text (and triggers the animation) when it is visible within the viewport, with the help of the Intersection Observer. With this prop you can control when the text is visible, ignoring the default behavior.

transitionDuration

Type: number | Required: false | Default: 0.8

The transition duration in seconds for each animation.

initialDelay

Type: number | Required: false | Default: 0

The initial delay in seconds for the animations to start.

lineDelay

Type: number | Required: false | Default: 0.3

The delay in seconds for the animations between lines.

wordDelay

Type: number | Required: false | Default: 0

The delay in seconds for the animations between words.

Styling

In case you want to change the animation of each word there are data attributes that help you do that:

.container {
    & [data-attribute="word"] {
        transform: translate3d(100%, 0, 0);
    }

    &[aria-hidden="false"] {
        & [data-attribute="word"] {
            transform: translate3d(0, 0, 0);
        }
    }
}

Tests

$ npm test
$ npm test -- --watch # during development

Demo

A demo Next.js project is available in the /demo folder so you can try out this component.

First, build the react-animate-text project with:

$ npm run build

Note: Everytime a change is made to the package a rebuild is required to reflect those changes on the demo. While developing, it may be a good idea to run the dev script, so you won't need to manually run the build after every change

$ npm run dev

To run the demo, do the following inside the demo's folder:

$ npm i
$ npm run dev

FAQ

I can't override the component's CSS, what's happening?

There is an ongoing next.js issue about the loading order of modules and global CSS in development mode. This has been fixed in v9.3.6-canary.0, so you can either update next.js to a version higher than v9.3.5, or simply increase the CSS specificity when overriding component's classes, as we did in the demo, e.g. having the page or section CSS wrap the component's one.

License

Released under the MIT License.