lines-split
v1.0.1
Published
Split and wrap each lines of your text in html tag
Downloads
3
Readme
Split in lines
Use cases
It is very useful to create text animations.
Installation
npm install lines-split
Usage
import SplitInLines from 'lines-split'
const paragraph = document.querySelector('p')
new SplitInLines(paragraph)
Instance settings
| Option | Type | Default | Description |
| --- | --- | --- | --- |
| target
| HTMLElement
| undefined
| Text element to split |
Instance props
| Property | Type | Description |
| --- | --- | --- |
| element
| HTMLElement
| Splited element |
| isVisible
| boolean
| Whether or not slideUp()
animation is completed. Set to true
when animation is completed. |
| params
| object
| Instance parameters : width: number
words: string[]
lines: NodeListOf<HTMLSpanElement>
` |
Instance methods
| Option | Description |
| --- | --- |
| slideUp()
| Basic text animation |
| resize()
| Recreate each line in relation to element's width |