1.0.2 • Published 5 years ago

vue-typist v1.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

Vue-typist

preview

A component for Vue.js that simulates a real person typing and deleting their text.
Please ignore the slow framerate in the gif preview, the actual package runs at 60fps. Give it a go and see for yourself.

Installing

Install the package

yarn add vue-typist
# or
npm install --save vue-typist

Usage

Import the component either locally..

import Typist from "@milkcartongirl/vue-typist";

export default {
    components: {
        Typist
    }
}

.. or globally

import Typist from "@milkcartongirl/vue-typist";
Vue.use(Typist);

You can now use the <typist /> component. See the documentation for the supported options.

Documentation

OptionTypeDefaultExplanation
words (required)ArrayString-An array of words you want to be typed out.
type-intervalNumber50The delay between each keystroke. In milliseconds.
pause-intervalNumber2000The pause after a word has been typed and after it has been erased. In milliseconds.
humanBooleanfalseA changing delay between keystrokes which makes the typing feel more "human".

License

This project is licensed under the MIT License - see the license.md file for details.