JSPM

bionic-converter

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q17712F
  • License MIT

Convert text to Bionic Reading format

Package Exports

  • bionic-converter
  • bionic-converter/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bionic-converter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bionic-converter

npm module Convert text to bionic reading format. Example: Lorem ipsum dolor sit amet, consectetur

Demo

const bionicConvert = require('bionic-converter')

console.log(bionicConvert("Lorem ipsum dolor sit amet, consectetur"))

<b>Lor</b>em <b>ips</b>um <b>dol</b>or <b>s</b>it <b>am</b>et, <b>consec</b>tetur

Fixation point

Set fixation point from 1 - 5 (default 3)

bionicConvert("Lorem ipsum dolor sit amet.", 1)
> <b>Lor</b>em <b>ips</b>um <b>dol</b>or <b>si</b>t <b>ame</b>t, <b>consectet</b>ur

Output for fixation point 1: Lorem ipsum dolor sit amet, consectetur

bionicConvert("Lorem ipsum dolor sit amet.", 5)
> <b>Lo</b>rem <b>ip</b>sum <b>do</b>lor <b>s</b>it <b>a</b>met, <b>con</b>sectetur

Output for fixation point 5: Lorem ipsum dolor sit amet, consectetur

Separator Set separator by passing array as third argument, this example will output markdown.

bionicConvert("Lorem ipsum dolor sit amet.", 3, ['**','**'])
> **Lor**em **ips**um **dol**or **s**it **am**et, **consec**tetur

Using strong html tags

bionicConvert("Lorem ipsum dolor sit amet.", 3, ['<strong>','</strong>'])
> <strong>Lor</strong>em <strong>ips</strong>um <strong>dol</strong>or <strong>s</strong>it <strong>am</strong>et, <strong>consec</strong>tetur