Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/interactive-pioneers/iptools-jquery-accordion
A simple jQuery accordion plugin.
https://github.com/interactive-pioneers/iptools-jquery-accordion
accordion jquery
Last synced: about 1 month ago
JSON representation
A simple jQuery accordion plugin.
- Host: GitHub
- URL: https://github.com/interactive-pioneers/iptools-jquery-accordion
- Owner: interactive-pioneers
- License: gpl-3.0
- Created: 2015-05-26T18:45:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-09T12:56:38.000Z (over 7 years ago)
- Last Synced: 2024-10-11T20:32:28.861Z (about 1 month ago)
- Topics: accordion, jquery
- Language: JavaScript
- Homepage:
- Size: 118 KB
- Stars: 0
- Watchers: 14
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# iptools-jquery-accordion [](https://travis-ci.org/interactive-pioneers/iptools-jquery-accordion) [](http://badge.fury.io/bo/iptools-jquery-accordion)
jQuery accordion plugin
## Features
Lightweight and easy to use jQuery accordion plugin.
## Requirements
- jQuery >= 1.11.3
## Example
```html
$(document).ready(function() {
$('.accordion').iptAccordion({
animationSpeed: 500,
singleOpen: true,
baseClass: 'accordion',
initializedClass: 'accordion--initialized',
panelClass: 'accordion__panel',
panelActiveClass: 'accordion__panel--active',
triggerClass: 'accordion__trigger',
triggerActiveClass: 'accordion__trigger--active',
contentClass: 'accordion__content',
contentActiveClass: 'accordion__content--active'
});
});
```
## Options
Name | Default | Type | Description
:------------------|:-----------------------------|:--------|:-----------
animationSpeed | `500` | int | Animation speed in miliseconds.
singleOpen | `true` | boolean | Only one open panel at a time.
baseClass | `accordion` | string | Base class of the accordion.
initializedClass | `accordion--initialized` | string | Class added to the accordion after initialization.
panelClass | `accordion__panel` | string | Class of panel.
panelActiveClass | `accordion__panel--active` | string | Class of active panel.
triggerClass | `accordion__trigger` | string | Class of trigger element.
triggerActiveClass | `accordion__trigger--active` | string | Class of active trigger element.
contentClass | `accordion__content` | string | Class of content element.
contentActiveClass | `accordion__content--active` | string | Class of active content element.
## Data attributes
Name | Type | Description
:------------------|:--------|:-----------
data-accordion-panel-activated | boolean | Denotes active panel opened on plugin initilization. See also `panelActiveClass` option.
## Events
### Emitted events
Event | Emitter | Description
:----- | :-------- | :-----------
`initialized.iptAccordion` | wrapper / base element | On successful plugin initialization |
`beforeOpen.iptAccordion` | individual panel | Before panel is opened |
`afterOpen.iptAccordion` | individual panel | After panel has been opened (animation complete) |
`beforeClose.iptAccordion` | individual panel | Before a panel is closed |
`afterClose.iptAccordion` | individual panel | After panel has been closed (animation complete) |
### Subscribed events
Event | Action
:----- | :-----------
`open.iptAccordion` | Opens panel |
`close.iptAccordion` | Closes panel |
`toggle.iptAccordion` | Toggles panel |
## Licence
Copyright © 2015-2016 Interactive Pioneers GmbH. Licenced under [GPL-3](LICENSE).