Skip to content

hinterdupfinger/speed-read

Repository files navigation

Built With Stencil

SpeedRead 📖

A webcomponent for speed reading, to reduce the need of eye movement.

Usage

You can include it in your website like any other webcomponent (https://stenciljs.com/docs/overview).

Example usage (for more detail check the component Readme):

<speed-read wpm="250" text="<YOU_TEXT>"></speed-read>

By clicking on the component you can start and pause the reading, but there are also exposed functions you can call to start and stop the reading with the buttons in you websites styles.

To get the text you could either directly pass the article of your cms or use https://github.com/mozilla/readability to extract it again of any website.

Styling

To also adjust the appearance there are css costom variables to adjust the fonts and colors:

  • --speed-read-font-size
  • --speed-read-font-family
  • --speed-read-color-text
  • --speed-read-color-text-focus

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published