untyper
v0.0.10
Published
a simple typewriter for browser
Downloads
26
Maintainers
Readme
^^_^^ untyper
Looking forward to your feedback
Live demo
A simple typewriter for browser,Typing effects can be achieved using chained methods
🛹 TODO
- [x] support custom typing effect
- [x] support custom cursor
- [x] support move cursor
- [x] support add any document node
- ...
🚀 Feature
- use Web Animations API Api to achieve typing effect
- Support custom typing speed
- Support chained methods
📦 Install
npm install untyper
Usage
import { UnTyper } from 'untyper'
const text = document.querySelector('#text')
const unTyper = new UnTyper(text, { speed: 100, startDelay: 1000 })
unTyper.type('hi', { delay: 200 }).go()
Api
type
Warning: only support string input
- text
string
- opts:
object
{ delay?:number
, startDelay:number
, animationspancontent:string
, animate: { cancel:boolean
, },}
output
this
pause
input
- ms
number
output
this
delete
input
- charAt:
number
> 0 - opts:
object
-> delay?:number
output
this
move
input
- movementArg:
number | null
- opts?:
object
-> {to?:string
, delay?:number
}
output
this
add
input
- text
string | HTMLElement
- opts:
object
-> delay?:number
output
this
go
output
Promise