1.0.8 • Published 4 years ago

use-typer v1.0.8

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

react-use-typer

NPM JavaScript Style Guide

demo

Install

npm install --save use-typer

Usage

import React from "react";
import useTyper from "use-typer";

const MyComponent = () => {
    const myAnimatedText = useTyper(
        ["First words.", "Second words.", "third words", "..."],
        {
            typeSpeed: 20,
            eraseSpeed: 50,
            typeDelay: 1000,
            eraseDelay: 1000,
            once: false
        }
    );
    return <div>{myAnimatedText}</div>;
};

or if you prefer:

const MyComponent = () => {
    const myAnimatedText = useTyper("Single sentence or word", {
        ...my optional options,
        once: true, // Prevent loop.
        once: false // Will loop.
    });
    return <div>{myAnimatedText}</div>;
};

Options

NameTypeDefault valueIs RequiredDescription
... Array of string YesAn array or a string of words you want to be displayed.
{ ... }Object{}YesTyping options, can be empty but required.
typeSpeedNumber (ms)100NoSpeed at which letters will be typed.
eraseSpeedNumber (ms)50NoSpeed at which letters will be erased.
typeDelayNumber (ms)1000NoDelay between words before begins typing.
eraseDelayNumber (ms)1000NoDelay between words before begins erasing.
oncebooleanfalseNoIf true the string or the first word in the array will be typed once.

License

MIT © JeremieNallet


This hook is created using create-react-hook.

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago