# jatrix-react

> A matrix-like text thing.

Latest version **0.2.0** (published 2019-03-02) · 0 weekly downloads

## Install

```sh
npm install jatrix-react
pnpm add jatrix-react
yarn add jatrix-react
bun add jatrix-react
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-03-02 |
| First published | 2019-03-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ian Fabs |
| Maintainers | ianfabs |

## Links

- npm: https://www.npmjs.com/package/jatrix-react
- npm.io page: https://npm.io/package/jatrix-react

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^15.5.4
- [webpack](https://npm.io/package/webpack.md) ^2.6.1

## Recent versions

- 0.2.0 (latest) — 2019-03-02
- 0.1.2 — 2019-03-02
- 0.1.1 — 2019-03-02
- 0.1.0 — 2019-03-02
- 0.0.1 — 2019-03-02

## README

# Enter the Jatrix
(pronounced Jay-tricks, like matrix)

Jatrix does this matrix like text thing, it's really cool!

<frameset cols="*">

<frame src="https://codesandbox.io/embed/006zx206zv?autoresize=1&fontsize=14&hidenavigation=1&view=preview" style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin">
</frame>

</frameset>

[![Edit Jatrix](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/006zx206zv?fontsize=14&view=preview)

Long story short, jatrix-react is a react component, as such it needs props.

| Prop   |   Type   |  Description                                                  | Default |
|--------|----------|---------------------------------------------------------------|---------|
| `text` | String   | The words that you want to render                             | None    |
| `fps`  | Number   | Frames per second, A.K.A how fast you want your letters to go | `40`    |
| `caps` | Boolean  | If it should be rendered in caps or not                       | `false` |
| `done` | Function | A callback that executes when it completes                    | `()=>{}`|

The name attribute allows you to write it as a self closing tag, like this:
```jsx
<Jatrix
  text="Ian Fabs"
/>
```

versus writing it like this:

```js
<Jatrix>
  Ian Fabs
</Jatrix>
```

But *both of them* **do indeed work**.

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