TextVide (vide; Latin for "see")
Support all languages that separate words with spaces
An Open-Source JavaScript Implementation of Bionic Reading API.
💫
Features
| Feature | State |
|---|---|
| HTML Mode |
|
| Markdown Mode |
|
| Custom HTML or Markdown Style |
|
| Fixation-Points |
|
| Saccade | #21 |
⚙️
Install
npm i text-vide
yarn add text-vide
pnpm add text-vide
📖
Usage
ESM (Browser)
import { textVide } from 'text-vide';
const text =
'Bionic Reading is a new method facilitating the reading process by guiding the eyes through text with artificial fixation points. As a result, the reader is only focusing on the highlighted initial letters and lets the brain center complete the word. In a digital world dominated by shallow forms of reading, Bionic Reading aims to encourage a more in-depth reading and understanding of written content.';
const highlightedText = textVide(text);
console.log(highlightedText); // 'Bionic Reading ... written content.'
CommonJS (NodeJS)
const { textVide } = require('text-vide');
const text =
'Bionic Reading is a new method facilitating the reading process by guiding the eyes through text with artificial fixation points. As a result, the reader is only focusing on the highlighted initial letters and lets the brain center complete the word. In a digital world dominated by shallow forms of reading, Bionic Reading aims to encourage a more in-depth reading and understanding of written content.';
const highlightedText = textVide(text);
console.log(highlightedText); // 'Bionic Reading ... written content.'
📚
API
textVide(text: string, options?: Options)
textVide('text-vide');
textVide('text-vide', {
// ... Options
});
Options
type Options = Partial<{
sep: string | string[];
fixationPoint: number;
}>;
sep
- Default Value:
['', '']
Passing a string allows you to specify the Beginning and End of the highlighted word at once.
textVide('text-vide', '**'); // '**tex**t-**vid**e'
It can also set them up by passing a list of length 2.
textVide('text-vide', ['', '']); // 'text-vide'
fixationPoint
- Default Value:
1 - Range:
[1, 5]
// Default fixation-point: 1
textVide('text-vide'); // 'text-vide'
// Changed fixation-point: 5
textVide('text-vide', { fixationPoint: 5 }); // 'text-vide'
License
MIT @Gumball12
27 Dec 17, 2022
35 Dec 5, 2022
15 Nov 8, 2022
3k Jan 4, 2023
175 Dec 24, 2022
210 Jan 4, 2023
15 Oct 23, 2022
4 Oct 9, 2022