# @icarolavrador/react-typewriter

> Made with create-react-library

Latest version **1.1.0** (published 2021-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @icarolavrador/react-typewriter
pnpm add @icarolavrador/react-typewriter
yarn add @icarolavrador/react-typewriter
bun add @icarolavrador/react-typewriter
```

## 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.1.0 |
| Published | 2021-01-17 |
| First published | 2021-01-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | icaroNZ |
| Maintainers | icaronz |

## Links

- npm: https://www.npmjs.com/package/@icarolavrador/react-typewriter
- Repository: https://github.com/icaroNZ/react-typewriter
- Homepage: https://github.com/icaroNZ/react-typewriter#readme
- Issues: https://github.com/icaroNZ/react-typewriter/issues
- npm.io page: https://npm.io/package/@icarolavrador/react-typewriter

## Recent versions

- 1.1.0 (latest) — 2021-01-17
- 1.0.0 — 2021-01-16

## README

# react-typewriter

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

## Description

The simplest typewriter effect component in React.

![](example/public/assets/typewriter.gif)

## Install

```bash
npm install --save @icarolavrador/react-typewriter
```

## Usage

```jsx
import React from 'react'

import Typewriter from 'react-typewriter'
import 'react-typewriter/dist/index.css'

const App = () => {
  const textArrayExample = [
    'small',
    'medium, this is a medium size text example',
    'long text, this is a long text to server as an example how long text work!'
  ]
  return <Typewriter textArray={textArrayExample} />
}

export default App
```

## SASS variables to override

```scss
$typewriter-color-text: #525f7f;
$typewriter-color-underline: #d50000;
$typewriter-text-size: 1.25rem;
```

## Sample page

https://icaronz.github.io/react-typewriter/

## License

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

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