TextSplitter properties

Properties available on the TextSplitter instance returned by a splitText() function.

const split = splitText(target, parameters);
      ┌──────┐
split.│lines │
split.│words ├─ Properties
split.│chars │
      └──────┘

Name	Description
$target	Gets the split root element (`HTMLElement`)
html	Gets the html to split (`String`)
debug	Gets if the debug styles are visible or not (`Boolean`)
includeSpaces	Gets if the spaces should be wrapped within the text (`Boolean`)
accessible	Gets if the accessible clone element should be created (`Boolean`)
lines	Gets the lines elements (`Array<HTMLElement>`)
words	Gets the lines elements (`Array<HTMLElement>`)
chars	Gets the lines elements (`Array<HTMLElement>`)
lineTemplate	The line html template (`String`)
wordTemplate	The word html template (`String`)
charTemplate	The char html template (`String`)

Previous Next