easy-toggle-state
v1.16.0
Published
A tiny JavaScript library to easily toggle the state of any HTML element in any contexts, and create UI components in no time.
Downloads
4,466
Maintainers
Readme
A tiny JavaScript library to easily toggle the state of any HTML element in any contexts, and create UI components in no time.
Dropdown, navigation button, tooltip, collapsible panel, lightbox, tabs, switches… UI components made in minutes without worried about JavaScript. Only set a few HTML attributes, and code the rest with your CSS skills.
See some examples in the documentation.
Status
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:
- Direct download
- Choose another version: ES5 or ES6
- Link from cdnjs
- Install with npm:
npm install easy-toggle-state
Documentation
Easy Toggle State's full documentation is hosted on GitHub Pages at twikito.github.io/easy-toggle-state/.
Contribution
- Clone the repo:
git clone https://github.com/twikito/easy-toggle-state.git
- Development:
npm run build
- Fork repository on GitHub
- Report a bug
- Suggest a feature
License
MIT. Copyright (c) Matthieu Bué