# react-scripted-text

> React component and hook to display script-based text output.

Latest version **0.1.1** (published 2022-09-25) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2022-09-25 |
| First published | 2022-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 54.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ZJVieth |
| Maintainers | zjvieth |

## Links

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

## Recent versions

- 0.1.1 (latest) — 2022-09-25
- 0.1.0 — 2022-09-24

## README

# react-scripted-text (Alpha)

> React component and hook to display script-based text output.


[![NPM](https://img.shields.io/npm/v/react-scripted-text.svg)](https://www.npmjs.com/package/react-scripted-text) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save react-scripted-text
```

## Usage

```jsx
import React from 'react'

import ScriptedText from 'react-scripted-text'

const App = () => {
  return (
    <div>
      <ScriptedText script="text_script.txt" />
      {/* or */}
      <div>
        { useScriptedText({script_file: "text_script.txt"})}
      </div>
    </div>
  )
}

export default App
```

```txt
// see github example/public/script.txt for an example
// this section will be updated soon
```

## Version History

### 0.1.1 Usability Fixes
- removed console.logs
- changed ScriptedText property to *script* (formerly *script_file*)

### 0.1.0 Alpha Release
- ScriptedText component
- useScriptedText hook
- Available commands: langs, set (lang, delay, speed), *n, wait, clear

## License

MIT © [ZJVieth](https://github.com/ZJVieth)

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