@nsmichelj/react-typewriter

React library to create typewriter animations.

Installation

npm install @nsmichelj/react-typewriter

Usage

import Typewriter from "@nsmichelj/react-typewriter";
function App() {
  return <Typewriter text="Hello world" />;
}

export default App;

Props

Prop Name	Type	Default	Description
text	string	Required	The text to be displayed with the typewriter effect.
delay	number	100	The initial delay before typing starts (in milliseconds).
typingSpeed	number	100	The time between typing each character (in milliseconds).
loop	boolean	false	If true, the typewriter effect will loop after finishing the text.
delayOnRestart	number	1000	The delay before restarting the typewriter effect when looping (in milliseconds).
cursor	boolean	false	If true, a blinking cursor will be displayed at the end of the typing text.
typingBackspaceAnimation	boolean	false	If true, a backspace animation will be triggered, deleting the text character by character. This will only execute once if loop is false.
typingBackspaceSpeed	number	100	The speed of the backspace animation, in milliseconds per character.
className	string	""	CSS class to apply to the root element.
style	object	{}	Inline styles to apply to the root element.