tik-attributed-text

Encodes and decodes TikApi::v5 text attributes to HTML

Install

1$ npm install --save tik-attributed-text

Usage

Below is a example of usage.

1var attrsTextToHTML = require('tik-attributed-text/to-html');
2attrsTextToHTML("Hello World!", [
3  {
4    _type: "Tik::ApiModel::Text::BoldSpan",
5    start: 2,
6    end: 6
7  },
8  {
9    _type: "Tik::ApiModel::Text::ItalicSpan",
10    start: 4,
11    end: 8
12  }
13]); // => "He<strong>ll<em>o </em></strong><em>Wo</em>rld!"

1HTMLtoAttrs("He<strong>ll<em>o</em></strong><em> Wo</em>rld!"); /* => {
2  text: "Hello World!",
3  attrs: [
4    { _type: 'Tik::ApiModel::Text::BoldSpan', start: 2, end: 6 },
5    { _type: 'Tik::ApiModel::Text::ItalicSpan', start: 4, end: 8 }
6  ]
7}*/

Options

to-attrs:

replaceBrTagWithNewLine

default: false

replaces <br> tags with new lines \n

to-html:

proxyDocument

default: undefined (Browser document)

if you want to run this function in a browserless environment like node

skipIntersectionsCompress

default: false

if you want to skip intersections normalization

replaceNewLinesWithBrTag

default: false

replaces new lines \n with <br> tags