Vuejs-typing NPM

Installation Guide

This guide will help you install and use the directive in your Vue.js project.

Ensure you have the following installed on your system:

Install the package
Open your terminal and run the following command:
```
npm install vuejs-typing
```

You can use the directive either globally in your Vue application or locally in a single Vue component.

Global import

Import the directive and use it in your Vue application:

import { createApp } from 'vue'
import App from './App.vue'
import typing from 'vuejs-typing'

const app = createApp(App)

app.use(typing)

Local import

Import the directive and use it in your Vue component:

import { typing } from 'vuejs-typing'

export default {
  directives: {
    typing
  }
}

Use the directive

You can now use the directive in your Vue template:

<div v-typing="'Hello World'"></div>

Or with an object configuration:

<div v-typing="{ text: 'Hello World', typeSpeed: 100, hasCaret: true, caretSymbol: '|', wordSplit: false }"></div>

Property	Type	Default	Description
text	string	''	The text to be typed out.
typeSpeed	number	100	The speed at which the text is typed out. (ms)
hasCaret	boolean	true	Whether to display a caret at the end of the typing.
caretSymbol	string	'I'	The symbol to use for the caret.
wordSplit	boolean	false	Whether to split the text into words. If true, each word is typed out separately.
caret	object	null	The caret object. This is managed internally and should not be set manually.
onStart	function	null	A function to be called when the typing starts.
onEnd	function	null	A function to be called when the typing ends.