# light-typewriter

> flexible and light typewriter

Latest version **2.0.0** (published 2021-07-03) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install light-typewriter
pnpm add light-typewriter
yarn add light-typewriter
bun add light-typewriter
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-07-03 |
| First published | 2021-07-03 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 25.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | maciejmoczala |
| Maintainers | maciejmoczala |
| Keywords | typewriter, text, typing, light, spell, word |

## Links

- npm: https://www.npmjs.com/package/light-typewriter
- npm.io page: https://npm.io/package/light-typewriter

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-07-03
- 1.0.0 — 2021-07-03

## README

# how it differs from other typewriter-ish packages?

well, it gives you much more freedom than most popular packages, you can delete parts of text, make the typer stop for a while, this gives it a "real human effect"

# how this works?

like all code... it's magic

but serioulsly:

```javascript
import { Typewriter } from "light-typewriter";

const app = new Typewriter("typewriter-element-id", {
  speed: 200, // typing speed
  cursorSpeed: 500, // blinking speed
  cursorColor: "aquamarine", // as name suggests
  endDot: true, // show dot after cursor
});

app.queue.add(
  [
    app.wait.bind(app, 700),
    // Let me help you
    app.type.bind(app, "Let me help you"),
    app.wait.bind(app, 2000),
    // Let me
    app.delete.bind(app, 8),
    // Let me type for you
    app.type.bind(app, "type for you"),
    app.wait.bind(app, 2000),
  ],
  true // provide true for infinite loop
);
```

![showcase](https://moczala.com/cloud/showcase.gif)
you get the hang of it

# why I created this?

other typewriter-ish packages were either large in size, required jquery or didn't meet my requirements

[Visit my website](https://moczala.com)

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