Sydney205 / typeglide

Create typing effect on console. TypeGlide adds a dynamic touch by simulating a gradual appearance of text as if it's being typed

Typeglide

Installation

Quick Start

Speeds and Delays

Loops

Contributions

Extra features

---

📦 Installation

install with npm:

npm install typeglide

🚀 Quick start

Jump into action

const typeglide = require("typeglide");

var myArray = [
  "Good morning",
  "How are you today?",
  "Would you like a cup of coffee?",
];

typeglide({
  strings: myArray,
});

---

Speeds and Delays ⏱⚡

Customize typing and backspacing speed including delays

const typeglide = require("typeglide");

typeglide({
  // Strings to be typed
  strings: myArray,
  // Typing speed
  typeSpeed: 70,
  // Backspacing speed
  backSpeed: 50,
  // start Delay
  startDelay: 10,
  // Backspacing delay
  backDelay: 100,
});

---

Loops 🔁

Make loops...

const typeglide = require("typeglide");

typeglide({
  strings: myArray,
  // Activating loop
  loop: true,
  // Number of times you want to loop
  loopCount: 3,
});

Extra features:

Name	Required	Default	Description
backspace(bool)	no	true	Disable backspace to type each string on a new line
backspaceLastString(bool)	no	true	Whether to backspace last string on the array
shuffle(bool)	no	false	Shuffle the strings on the array
singleLine(bool)	no	false	Types strings on a single line
seperator(string)	when singleLine is activated	empty string	Seperate strings on single line

Contributions 🤝🏻

Have any features you wish to add?... Make a pull request to the repository on github.
Feel free to create issues or provide feedbacks!.

Author:

Sydney205

License 📄

Copyright (c) 2024 Dieke Sydney