Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/braposo/react-text-loop
Animate words in your headings
https://github.com/braposo/react-text-loop
animation cycle loop react react-component text
Last synced: 5 days ago
JSON representation
Animate words in your headings
- Host: GitHub
- URL: https://github.com/braposo/react-text-loop
- Owner: braposo
- License: mit
- Created: 2017-03-20T18:22:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T05:13:52.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T06:06:57.705Z (7 months ago)
- Topics: animation, cycle, loop, react, react-component, text
- Language: TypeScript
- Homepage: https://codesandbox.io/s/react-text-loop-playground-br4q1
- Size: 1.27 MB
- Stars: 868
- Watchers: 14
- Forks: 62
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - react-text-loop
README
## react-text-loop
An animated loop of text nodes for your headings. Uses
[react-motion](https://github.com/chenglou/react-motion) for the transition so it handles super fast
animations and spring params.
[![npm version][version-badge]][npm]
[![npm downloads][downloads-badge]][npm]
[![gzip size][size-badge]][size]
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
---
## Installation
`npm install react-text-loop` or `yarn add react-text-loop`
## How to use
[![Edit react-text-loop][codesandbox-badge]][codesandbox]
You can also run the examples by cloning the repo and running `yarn start`.
### Usage
```jsx
import TextLoop from "react-text-loop";
import Link from "react-router";
import { BodyText } from "./ui";
class App extends Component {
render() {
return (
First item
Second item
Third item
{" "}
and something else.
);
}
}
```
### Props
| Prop | Type | Default | Definition |
| -------------- | --------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| interval | number \| array | `3000` | The frequency (in ms) that the words change. Can also pass an array if you want a different interval per children |
| delay | number | `0` | A delay (in ms) for the animation to start. This allows to use multiple instances to create a staggered animation effect for example. |
| adjustingSpeed | number | `150` | The speed that the container around each word adjusts to the next one (in ms). Usually you don't need to change this. |
| 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 |
| noWrap | boolean | `true` | Disable `whitepace: nowrap` style for each element. This is used by default so we can always get the right width of the element but can have issues sometimes. |
| springConfig | object | `{ stiffness: 340, damping: 30 }` | Configuration for [react-motion spring](https://github.com/chenglou/react-motion#--spring-val-number-config-springhelperconfig--opaqueconfig) |
| className | string | | Any additional CSS classes you might want to use to style the image |
| children | node | | The words you want to loop (required) |
### Caveats
Because `` loops through its children nodes, only root-level nodes will be considered so
doing something like:
```jsx
First item
Second item
Third item
;
```
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.
```jsx
;
```
## Examples
### Fast transition
```jsx
...;
```
### Wobbly animation
```jsx
...;
```
For many other examples, please have a look at the [CodeSandbox playground][codesandbox].
## Contributing
Please follow our
[contributing guidelines](https://github.com/braposo/react-text-loop/blob/master/CONTRIBUTING.md).
## License
[MIT](https://github.com/braposo/react-text-loop/blob/master/LICENSE)
[npm]: https://www.npmjs.com/package/react-text-loop
[license]: https://github.com/braposo/react-text-loop/blob/master/LICENSE
[prs]: http://makeapullrequest.com
[size]: https://unpkg.com/react-text-loop/dist/react-text-loop.min.js
[version-badge]: https://img.shields.io/npm/v/react-text-loop.svg?style=flat-square
[downloads-badge]: https://img.shields.io/npm/dm/react-text-loop.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/react-text-loop.svg?style=flat-square
[size-badge]: http://img.badgesize.io/https://unpkg.com/react-text-loop/dist/react-text-loop.min.js?compression=gzip&style=flat-square
[modules-badge]: https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20esm-green.svg?style=flat-square
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[codesandbox-badge]: https://codesandbox.io/static/img/play-codesandbox.svg
[codesandbox]: https://codesandbox.io/s/react-text-loop-playground-br4q1