react-text-loop

An animated loop of text nodes for your headings. Uses react-motion for the transition so it handles super fast animations and spring params.

---

Installation

npm install react-text-loop || yarn add react-text-loop

How to use

Code

import TextLoop from 'react-text-loop';

class App extends Component {
    render() {
        return (
            <h2>
                <TextLoop>
                    <span>First item</span>
                    <Link to="/">Second item</Link>
                    <BodyText>Third item</BodyText>
                </TextLoop> and something else.
            </h2>
        );
    };
}

Props

Prop	Type	Default	Definition
speed	number	3000	The speed that the words change (in ms). Set to 0 to stop animation.
adjustingSpeed	number	150	The speed that the container around each word adjusts to the next one (in ms)
fade	boolean	true	Enable or disable the fade animation on enter and leave
mask	boolean	false	Mask the animation around the bounding box of the animated content
springConfig	object	{ stiffness: 340, damping: 30 }	Configuration for react-motion spring
style	object or array		Any additional styles you might want to send to the wrapper. Uses glamor to process it so you can send either objects or arrays.
children	node		The words you want to loop (required)

Caveats

Because <TextLoop> loops through its children nodes, only root-level nodes will be considered so doing something like:

<TextLoop>
    <div>
        <span>First item</span>
        <span>Second item</span>
    </div>
    <div>Third item</div>
</TextLoop>

will make first and second item to be treated as one and animate together.

You can also just send a normal array as children prop if you don't need any individual styling for each node.

<TextLoop
    children={[
        "Trade faster",
        "Increase sales",
        "Stock winners",
        "Price perfectly"
    ]}
/>

Examples

Fast transition

<TextLoop speed={100}>
    ...
</TextLoop>

Wobbly animation

<TextLoop springConfig={{ stiffness: 180, damping: 8 }}>
    ...
</TextLoop>

Contributing

Please follow our contributing guidelines.

License

MIT