democracyos-toggle-parent
v0.1.0
Published
Toggle class on parent element.
Downloads
29
Maintainers
Readme
Toggle Parent
Simple component to toggle a class on parentNode of an element. When activated
a backdrop element (.toggle-parent-backdrop
) is added that will remove the
class when clicked.
Installation
With component:
$ component install mjlescano/toggle-parent
Example
<style type="text/css">
#dropdown-container.active .dropdown-menu {
display: block;
}
.dropdown-menu {
display: none;
}
</style>
<div id="dropdown-container">
<button type="button">Toggle Menu</button>
<ul>
<li>option 1</li>
<li>option 2</li>
<li>option 3</li>
</ul>
</div>
var ToggleParent = require('toggle-parent');
var button = document.querySelector('#dropdown-container button');
// Every time 'button' is pressed, the class 'active' will
// be toggled on '#dropdown-container'
var dropdown = new ToggleParent(button);
// Toggle programatically
dropdown.toggle()
Options
Options that can be passed as a second argument to new ToggleParent(button, opts)
- parent: Element to toggle the class (Default: button.parentNode)
- toggleClass: Class name to be toggled (Default:
active
)
API
- .show(): Add
toggleClass
toparent
- .hide(): Remove
toggleClass
fromparent
- .toggle(): Toggle
toggleClass
onparent
- .destroy(): Remove ToggleParent instance, with all the events attached.
License
MIT