ayitinya/vue-typewriter-effect

A Vue Js wrapper for typewriter-effect

Vue Typewriter Effect

Introduction

Vue Typewriter Effect is a Vue.js wrapper for Typewriter Effect package that has an average of over 10k weekly downloads. The package is a simple and lightweight library that allows you to use typewriter effect in your Vue.js projects with ease.

Getting Started

Install vue-typewriter-effect with npm:

npm install vue-typewriter-effect

with yarn:

yarn add vue-typewriter-effect

Usage

Import the component and register it globally in your Vue instance:

import { createApp } from "vue";
import App from "./App.vue";

const app = createApp(App);

app
    .component("vue-typewriter-effect", VueTypewriterEffect)
    .mount("#app");

or locally in your component:

import VueTypewriterEffect from "vue-typewriter-effect";

Use the component in your template:

<vue-typewriter-effect :strings="['hello', 'world']" />

Props

Name	Type	Default	Description
element	String	span	The HTML element to use for the wrapper.
strings	Array	["Hello", "World"]	Strings to type out when using autoStart option
cursor	String	pipe character	String value to use as the cursor.
delay	Number	natural	natural
deleteSpeed	Number	natural	natural
loop	Boolean	false	Whether to loop the strings.
autoStart	Boolean	true	Whether to start typing automatically.
pauseFor	Number	1500	The pause duration after a string is typed when using autostart mode.
devMode	Boolean	false	Whether or not to display console logs.
skipAddStyles	Boolean	false	Whether or not to skip adding styles to the document.
wrapperClassName	String	Typewriter__wrapper	The class name to use for the wrapper element.
cursorClassName	String	Typewriter__cursor	The class name to use for the cursor element.
stringSplitter	Function	null	A function that splits the string into an array of characters. Example
onCreateTextNode	Function	null	Callback function to replace the internal method which creates a text node for the character before adding it to the DOM. If you return null, then it will not add anything to the DOM and so it is up to you to handle it.
onRemoveNode	Function	null	Callback function when a node is about to be removed. First param will be an object { node: HTMLNode, charater: string }

See the Typewriter Effect package for more information.

vue-typewriter-effect's Issues

Could not find a declaration file?

I'm following your tutorial here: https://blog.ayitinya.me/articles/how-to-create-and-publish-vue-component-to-npm

I'm doing the following:

1. clone your repo
2. npm run build
3. npm pack
4. npm install vue-typewriter-effect-1.0.1.tgz on my sample vue project
5. import TypewriterEffect from "vue-typewriter-effect";

Your module works great, but the only thing is I'm seeing red from typescript that I'm unsure of how to solve. Do you have any ideas?