dom-typer.js's Introduction

dom-typer.js

what is dom-typer.js?

dom-typer is a plugin witten in JavaScript, which can be used to output a string in typer style.

usage

Installation


npm install dom-typer --save

Import

import Typer from 'dom-typer'

Basic Use

const typer = new Typer('I will be output letter by letter.')
typer.type((o) => {
    console.log(o)
})

// you can reuse later by doing this
typer.targetString = 'Other string that you want to output.'
typer.type((o) => {
    console.log(o)
})

// alternatively, you can use callback to do something when entire process finished
typer.type(
    // first parameter will be called every time when each letter finished typing
    (currentOutput) => {},

    // second parameter will be called when the whole string finished typing
    (entireOutput) => {
        console.log('Typing work finished! ')
    }
)

Render DOM

I created this plugin to better show typer style in web-app, so you can also do this to render your styled text. Here is an example to use it in a Vue project:

<template>
    <div>{{ msg }}</div>
</template>

import Typer from 'dom-typer'

export default {
    data() {
        return {
            msg: '',
        }
    },

    mounted() {
        new Typer('String that you want to render letter by letter.').type((o) => {
            this.msg = o
        })
    },
}

Bold Style

Bold text is also supported. What you need is to wrap the specific text part with **, just like MarkDown syntax, and then the text rendered in your web-app will become bold style.

new Typer('String that you want to partly **accent**. ').type((o) => {
    // receive the output string with bold part wrapped with <strong></strong> markup tag
})

slot

const typer = new Typer()
typer.slot = { pickedPerson: 'Michael Jackson' }
typer.targetString = 'The person you just picked is `pickedPerson`.'
typer.type((o) => {
    console.log(o) // will output: The person you just picked is Michael Jackson.
})

Recommend Projects