Skip to content

BionicToggle is a lightweight, easy-to-use npm package that provides a toggle button for bionic reading. With BionicToggle, users can quickly and easily switch between normal text and bionic text, which is optimized for readability and comprehension.

License

Notifications You must be signed in to change notification settings

Pranav4399/bionic-toggle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BionicToggle

BionicToggle is a lightweight, easy-to-use npm package that provides a toggle button for bionic reading. With BionicToggle, users can quickly and easily switch between normal text and bionic text, which is optimized for readability and comprehension. Installation

To install BionicToggle, simply run:

npm install bionictoggle

Usage

To use BionicToggle, you can import the module into your JavaScript file like this:

import BionicToggle from 'bionictoggle';

Instructions

BionicToggle requires 'contentClassName' prop to be passed to it which holds the class name of the div inside which the blog text is rendered. As of today, BionicToggle supports rendering of p, span tags. Further additions will be done over the period of time.

Contributions

Contributions are welcome! If you have any ideas for improvements or new features, feel free to open an issue or submit a pull request.

License

BionicToggle is licensed under the MIT License. See the LICENSE file for more details.

About

BionicToggle is a lightweight, easy-to-use npm package that provides a toggle button for bionic reading. With BionicToggle, users can quickly and easily switch between normal text and bionic text, which is optimized for readability and comprehension.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published