@mcarlssen/typeon-react v1.0.3

TypeOn React Component

A simple and customizable React component that creates a typewriter effect for text animation. Written in TypeScript with zero dependencies.

https://github.com/mcarlssen/react-typeon

Features

• Lightweight and performant
• Zero dependencies
• Fully customizable

Installation

npm install @mcarlssen/typeon-react
# or
yarn add @mcarlssen/typeon-react

Usage

import { TypeOn } from 'typeon-react';

function App() {
  return (
    <TypeOn
      phrases={['Hello World!', 'Welcome to my website', 'This is a typewriter effect']}
      baseSpeed={24}
      pauseDuration={3000}
      className="my-custom-class"
    />
  );
}

Props

Styling

The component renders a span element with your provided className, which contains the phrases being typed-on. The typing cursor is rendered as a span with the class cursor. The cursor character is an underscore _ by default; you can change this by modifying the contents of the cursor span in TypeOn.tsx. You can style the typed phrase span and the cursor elements using CSS:

.type-on-text {
  font-family: monospace;
}

.cursor {
  animation: blink 1s step-end infinite;
}

@keyframes blink {
  from, to { opacity: 1; }
  50% { opacity: 0; }
}

Examples

Basic Usage

<TypeOn phrases={['Simple', 'Easy', 'Fast']} />

Custom Speed and Pause Duration

<TypeOn 
  phrases={['Faster typing', 'Longer pauses']}
  baseSpeed={50}  // Faster typing
  pauseDuration={5000}  // Longer pauses
/>

Custom Styling

<TypeOn 
  phrases={['Custom styled text']}
  className="my-fancy-text"
/>

Dependencies

This library has zero dependencies and only requires React as a peer dependency.

Note: The demo project in the repository includes additional dependencies, but these are only for demonstration purposes and are not required to use the library in your project.

Contributing

Contributions are welcome!

License

MIT © Mike Thorn (@mcarlssen)