# e-typewriter

> Typewriter Effect

Latest version **1.0.5** (published 2021-11-13) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-11-13 |
| First published | 2021-11-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Christopher Farmakis 'farmak@hotmail.com' |
| Maintainers | christopher_far |
| Keywords | typewriter, typist, keyboard, typing |

## Links

- npm: https://www.npmjs.com/package/e-typewriter
- Repository: https://github.com/christopherGr/typewriter
- Homepage: https://github.com/christopherGr/typewriter.git
- Issues: https://github.com/christopherGr/typewriter/issues
- npm.io page: https://npm.io/package/e-typewriter

## Recent versions

- 1.0.5 (latest) — 2021-11-13
- 1.0.4 — 2021-11-13
- 1.0.3 — 2021-11-13
- 1.0.2 — 2021-11-13
- 1.0.1 — 2021-11-13
- 1.0.0 — 2021-11-13

## README

<b>Typewritter Effect</b><br>
Accepts an element which supports innerHTML method, (no need for any style) with an id.<br>
const TypeWriter = require("e-typewriter.js");<br>	
const typewriter = new TypeWriter(document.getElementById("message-container"));<br>

<b>Methods</b><br>
typewriter.write(); or await typewriter.write();<br>
typewriter.clear(); or await typewriter.clear();<br>
typewriter.resetAll(); ////Stop the execution immediately. Clear all the timers.<br>
typewriter.setData(); //Set the displayed message<br>

<b>TypeWriter constructor</b><br>
new TypeWriter(el, time=4000, font="Verdana", fontSize="1em", textColor="hsla(240,100%,0%,100%)", caretColor="hsla(240,100%,0%,100%)", caretSize=1, deleteInterval=15);<br><br>

<b>Arguments</b><br>
1. An element from the document which supports innerHTML method and has an id, to display the message. (required)<br>
2. The total time in ms, that the effect will be completed. (optional)<br>
3. Font-family. (optional)<br>
4. Font-size (px, em, rem, %, vw, calc(vw+vh)). All units are accepted. (optional)<br>
5. Text color. ("black", hex color, hsla, rgba). All values are accepted. (optional)<br>
6. Caret color. ("black", hex color, hsla, rgba). All values are accepted. (optional)<br>
7. Caret size. Default size is 1. Accepts a number. For example 2, 1.3.. (optional)<br>
8. Interval time for deleting effect. (optional)<br>

***Caret will dissapeared after time\*2 seconds.<br>
***Caret size affects the line-height. It is recommended to use values larger that "1" only in a sinle line text.<br>

<b>Usage</b><br>

<b>npm i type-writer</b>

const TypeWriter = require("e-typewriter.js");<br>
const container = document.getElementById("message-container");<br>
const typewriter = new TypeWriter(container);<br>
typewriter.setData("Hello World!");<br>
typewriter.write();<br><br>

OR in async mode<br>
write();<br>

async function write(){<br>
	&nbsp;&nbsp;const TypeWriter = require("e-typewriter.js");<br>	
	&nbsp;&nbsp;const container = document.getElementById("message-container");<br>
	&nbsp;&nbsp;const typewriter = new TypeWriter(container);<br>
	&nbsp;&nbsp;typewriter.setData("Hello World!");<br>
	&nbsp;&nbsp;await typewriter.write();<br>
	&nbsp;&nbsp;typewriter.setData("How are you today?");<br>
	&nbsp;&nbsp;await typewriter.write();<br>
	&nbsp;&nbsp;await typewriter.clear();<br>
}<br><br>

Or you can include e-typewriter as a script. See example.

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