# shuffle-char

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

Latest version **0.0.3** (published 2017-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install shuffle-char
pnpm add shuffle-char
yarn add shuffle-char
bun add shuffle-char
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2017-05-04 |
| First published | 2016-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Shu Ding |
| Maintainers | quietshu |
| Keywords | react |

## Links

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

## Dependencies (1)

- [react](https://npm.io/package/react.md) ^15.2.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

- 0.0.3 (latest) — 2017-05-04
- 0.0.2 — 2016-07-24
- 0.0.1 — 2016-07-24

## README

# Char Shuffling for React

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

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

## Usage

```js
import Shuf from 'shuffle-char'
```

```jsx
<h1>
  <Shuf on={running} charset='a-zA-Z_' escape='()' idle={80}>Hack(FDU)</Shu>
</h1>
<h2>
  <Shuf on={running} charset='0-9' idle={80}>150</Shu>+ teams,
  <Shuf on={running} charset='0-9' idle={80}>500</Shu>+ participants
</h2>
```

## 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.

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