/easy-toggle-state

A tiny JavaScript library to easily toggle the state of any HTML element in any contexts.

Primary LanguageJavaScriptMIT LicenseMIT

Easy Toggle State

A tiny JavaScript library to easily toggle the state of any HTML element and its targets.

Dropdown, navigation button, tooltip, collapsible panel, lightbox, tabs, switch like above… UI components made in minutes without worried about JavaScript. Only set a few HTML attributes, and code the rest with your CSS skills.

npm version dependencies Status devDependencies Status code style: prettier contributions welcome GitHub license

Why?

A front-end developer often has to code scripts for interface components. Components such as drop-downs, navigation buttons, tooltips, expandable panels, lightboxes, tabs, etc.

The thing is… Most of these components expose a recurrent behavior: a trigger element toggles the state of one or more target elements. So why not code this behavior once and for all?

So here is a solution: a simple script to toggle the state of a trigger element with a CSS class. You can then associate this element with one or more others: let's call them targets. By adding the right HTML attributes, it can adapt to any contexts and behave like a chosen component.

Only focus on adjusting the rest with your CSS creativity.

Quick start

Several quick start options are available:

Then, add the script into your page, and it's done.

Documentation

Easy Toggle State's documentation is hosted on GitHub Pages at twikito.github.io/easy-toggle-state/.

Contribution

License

MIT. Copyright (c) Matthieu Bué