https://github.com/shuding/shuffle-char

React char shuffling animation.
https://github.com/shuding/shuffle-char

animation char-shuffling react

Last synced: 26 days ago
JSON representation

React char shuffling animation.

• Host: GitHub
• URL: https://github.com/shuding/shuffle-char
• Owner: shuding
• License: mit
• Created: 2016-07-24T14:16:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-04T12:54:49.000Z (over 7 years ago)
• Last Synced: 2024-05-20T15:12:08.172Z (6 months ago)
• Topics: animation, char-shuffling, react
• Language: JavaScript
• Homepage:
• Size: 164 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Char Shuffling for React

![](https://img.shields.io/npm/v/shuffle-char.svg?style=flat)

`npm i shuffle-char -S` or `yarn add shuffle-char`

## Usage

```js

import Shuf from 'shuffle-char'

```

```jsx



  Hack(FDU)





  150+ teams,

  500+ participants



```


## Demo

![screenshot](screenshot.gif)

## API

Props supported:

- `on`: boolean,

    If `true` the animation will keep running, else it will display the default value.

- `charset`: string,

    `'a-z'` / `'A-Z'` / `'0-9'` + any characters. e.g. `'a-zA-Z_'` includes all alphabets and underscore.

- `escape`: string,

    Characters excluded from the `charset` above. e.g. `charset='a-z'` and `escape='x'` includes all lowercase letters exclude `x`.

- `idle`: number,

    The animation interval in ms.

## License

The MIT license.