react-speed-reader

react-speed-reader

Install

npm install react-speed-reader (peer dependencies: react react-dom)

for React v0.13.3 npm install react-speed-reader@1.0.3

Demo

Check out Live Example and the example code, or run it locally

git clone [e-mail]:Radivarig/react-speed-reader.git
npm install
npm run dev 

open localhost:8080

Features

• flash one or more words
• on one word flash, show highlighted pivot letter (the red focus)
• set words per minute (WPM)
• pause after character match
• trim sentence after character match
• show blank after character match
• TODO: multiple rows
• TODO: trim by row length*

Basic Usage

Check the Example GUI for full demonstration.

// ...
    <SpeedReader
        inputText={'Something to read'}
        speed={250}
        isPlaying={True}
    
        //bellow is optional

        trim={{regex: /\.|,|\?|!/} /*trim sentence*/}
        offset={{regex: /\.|,|\?|!/, duration: 0.5} /*pause for 0.5 times the WPM speed*/}
        blank={{regex: /\.|\?|!/, duration: 0.5} /*show blank*/}

        chunk={1/*number of words per flash*/}
        pivotColor={'red'}
        reset={{/*resets when changed*/}}
        setProgress={{/*{ skipFor: Int OR percent: 0 to 1, timestamp: new Date().getTime() }*/}}

        hasEndedCallback={{/*call your pause fn to sync with GUI*/}}
        progressCallback={{/*calls with {at: Int, of: Int}*/}}
        wordPartsCallback={{/*if chunk is 1 calls with {pre: 'w', mid: 'o', post: 'rd'} else a String*/}}
        />

License

MIT