# react-shuffle-text

> React component that apply shuffle animation to text

Latest version **1.0.6** (published 2018-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-shuffle-text
pnpm add react-shuffle-text
yarn add react-shuffle-text
bun add react-shuffle-text
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2018-07-17 |
| First published | 2018-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 18.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | littlee |
| Maintainers | littlee |
| Keywords | react, shuffle, text, animation |

## Links

- npm: https://www.npmjs.com/package/react-shuffle-text
- Repository: https://github.com/littlee/react-shuffle-text
- Homepage: https://github.com/littlee/react-shuffle-text#readme
- Issues: https://github.com/littlee/react-shuffle-text/issues
- npm.io page: https://npm.io/package/react-shuffle-text

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.4.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.4.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2018-07-17
- 1.0.5 — 2018-07-16
- 1.0.4 — 2018-07-16
- 1.0.3 — 2018-07-16
- 1.0.2 — 2018-07-16
- 1.0.1 — 2018-07-16
- 1.0.0 — 2018-07-16

## README

# React Shuffle Text

![Preview](https://github.com/littlee/react-shuffle-text/blob/master/demo/preview.gif?raw=true)

## Basic Usage
install:
```
npm install -S react-shuffle-text
```

render:
```js
import ShuffleText from 'react-shuffle-text';


// somewhere in render function
<ShuffleText content="Zhuangbility" />

```

custom styles & effects:
```css
/* write styles for .shuffle-text-char with higher specificity */
.my-shuffle .shuffle-text-char {
  animation: 0.5s ease-in-out both myWordEnter; /* none for no effect */
}

@keyframes myWordEnter {
  0% {
    opacity: 0;
    transform: translate(-100%, 0) scale(5);
  }

  100% {
    opacity: 1;
    transform: translate(0, 0) scale(1);
  }
}
```

## Available Props
- content: PropTypes.string.isRequired
  - text wanted to display

- charIncInterval: PropTypes.number (default: 100)
  - character increasing time interval 

- charFrames: PropTypes.number (default: 10)
  - frame counts that each character plays

- charFrameTime: PropTypes.number (default: 50)
  - duration of each character frame

- more props are coming

---
_Source: https://npm.io/package/react-shuffle-text · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
