The Lector Experience

!npm-size
!npm-size
!npm-size
!npm-size

$3

Lector produces a reading enviroment, and summons a pointer that will help you read more efficient. It's sole purpose is to transfer a piece of text
in the most efficient way possible to your melting brain.

To achieve this, Lector attempts to move the pointer precisely as your eyes would move on the text. This creates a dynamic between the pointer, your eyes and
your mind. This dynamic can be expressed as "wiring in". Also known as super fucking focused on the text.

Contribute

First time:

``bash
git clone git@github.com:robo-monk/lector.git
cd lector
yarn install
`

- Python 3 required (prefferably installed with brew)
- virtualenv (pip install virtualenv)

Run this to compile the code when you make changes:

Depends on your package manager (my recommendation would be yarn)

`bash
source setup yarn
`

`bash
source setup npm
`

Install

$3

`bash
yarn add pragmajs animejs compromise mousetrap
`

$3

`javascript
import { Script } from 'pragmajs'

await Script.load('https://unpkg.com/lectorjs@latest/dist/lector.umd.js')
lectorjs.globalify() //loaded
`

#### Development

`javascript
import { Script } from 'pragmajs'

console.time('📖 [lectorjs] load...')
await Script.load('https://unpkg.com/lectorjs@latest/dist/lector.umd.js', 'lector')
console.timeEnd('📖 [lectorjs] load...')

lectorjs.globalify() //loaded

// ...
`

Set up

$3

The simplest way you can hookup Lector to your document is like this:

`javascript
lec = Lector('#article')

// or if you want to await the initialization
;(async () => {
await Lector('#article', options)
})()
`

This will trigger a pointer to the element's text, and generate a toolbar to control the pointer's settings.

$3

You can declare Lector with many settings:

`javascript
settings = {
debug: false,
onboarding: false,
wfy: true,
loop: false,
autostart: false,
autoscroll: false,

fullStyles: true,
defaultStyles: true,

scaler: true,
// set scaler: 'font-size' to scale the font instead of the parent element
// use 'em' units for line-height, in order for it to scale proportionaly to the
// scaled font

pragmatizeOnCreate: true,
experimental: true,

settings: true,
stream: fetchContent,
// function with index as param that
// returns the content for the page
// can return a promise

paginate: {
from: 'stream',
as: 'infiniteScroll',

config: {
first: 1,
last: 69,
headspace: 4,
timeout: 1,
onPageAdd,
onCreate,
onCreate,
onPageActive,
onPageInactive,
onPageDestroy,
},
},
}

lec = Lector('#article', settings)

// default options
const defaultOptions = {
onboarding: false,
wfy: true, // false if every word is already wrapped in tags on initializaiton
settings: false, // display a settings bar controlling the pointer's color, width, speed and more...
defaultsStyles: true, // inject basic styles
fullStyles: false, // will decoreate the background of the page, buttons & fonts
debug: false, // true if you want to see the lector logs #! When false, it hides all the console.log of the page - this will be refactored in new versions
hintPointer: true, // when the pointer is out of screen, display arrows on top/bottom of the window that hint its position
autoscroll: true, // sroll the view intelligently
disableWhenNotInView: false, // offload when not in view
global: false, // true if you want multiple lectors in the same page
experimental: false, // if true experimental features are enabled. Unstable.

// EXPERIMENTAL (set experimental: true to enable these options)
scaler: false, // if true, scales the view, if set to 'font-size' will scale the font size using em
stream: false, // this options only makes sense if you have paginated pages
paginate: false,
/*
paginate: {
from: 'stream',
as: 'infiniteScroll',
config: { ... }
}
*/
}
``