@cgoing/typing v0.1.0

install

npm install @cgoing/typing
yarn add @cgoing/typing

How to use

import createTyping from '@cgoing/typing'

const typing = createTyping( Element OR Element Id, options = { delay : 60, blink : true } )

typing.write('message')

API

return Promise
write('msg')  // element textContent delete and write
delete() // element textContent delete
append('msg') // element textContent append


run(Array) // Array type [ String, Number, Boolean ]
 // String is  write(text) or append(text) default write(text)
 // Number is wait(ms)
 // Boolean true : append(text)
 // Boolean false : write(text)

 example code

 import createTyping from '@cgoing/typing'
 const element = document.querySelector(`{selector}`)
 const typing = createTyping(element)

typing.run(['Hello world !', 3000, 'my name is', true, 'cgoing!', '\n good bye', 3000, ''])

// write('Hello world !') > wait( 3000 ) >  write('my name is') >
// append('my name is cgoing!') >  append('my name is cgoing! good bye') > delete()

example code 2

...
const testFunction = async () => {
    await typing.write('Hello')
    typing.applyOptions({ delay : 10,blink : false }) // typing speed
    await typing.append(' world ~ ')
}