vue-typewrite

0.1.11 • Public • Published

vue-typewrite npm version

This Vue.js plugin emulates typing in a text.

DEMO

Usage

Installation

npm i vue-typewrite

in your main.js file

import Vue from 'vue';
import Typewriter from 'vue-typewrite';
 
Vue.use(Typewriter);

In your application

<template>
    <v-type-write text="Hello World!"></v-type-write>
</template>

Configuration

name type default description
text string - required the text to be typed
typeDelay number 0 time until the text starts typing
typeSpeed number 150 time between each char typed in ms
caretColor string '#101010' color of the caret (any css color)
textColor string ''inherit color of the text (any css color)

For multiline texts use \n for now.

example

<v-type-write :text="'Multiline \n is also supported'"></v-type-write>
<v-type-write :typeDelay="150" text="I start typing after 150ms"></v-type-write>

contribute

  • clone this repo
  • npm i
  • npm run serve
  • make changes on new branch
  • update README
  • submit PR

Todo

  • be able to delete text
  • be able to select text
  • be able to loop the writing
  • accept array of textelements
  • render html elements like h1, p etc.
  • emit events
  • customize caret (like underscore, solid, easing)

License

MIT

Copyright © 2019-Present, René Heinen. All rights reserved.

Readme

Keywords

none

Package Sidebar

Install

npm i vue-typewrite

Weekly Downloads

13

Version

0.1.11

License

none

Unpacked Size

779 kB

Total Files

22

Last publish

Collaborators

  • blackfaded