0.3.1 • Published 6 years ago

iptools-jquery-accordion v0.3.1

Weekly downloads
1
License
GPL-3.0
Repository
github
Last release
6 years ago

iptools-jquery-accordion Build Status Bower version

jQuery accordion plugin

Features

Lightweight and easy to use jQuery accordion plugin.

Requirements

  • jQuery >= 1.11.3

Example

<div class="accordion">
  <div class="accordion__panel">
    <div class="accordion__trigger"></div>
    <div class="accordion__content"></div>
  </div>
  <!-- panels with panelActiveClass will be opened automatically on plugin initialization -->
  <div class="accordion__panel accordion__panel--active">
    <div class="accordion__trigger"></div>
    <div class="accordion__content"></div>
  </div>
  <!-- panels with data-accordion-panel-activated will also be opened automatically on plugin initialization -->
  <div class="accordion__panel" data-accordion-panel-activated="true">
    <div class="accordion__trigger"></div>
    <div class="accordion__content"></div>
  </div>
  <div class="accordion__panel">
    <div class="accordion__trigger"></div>
    <div class="accordion__content"></div>
  </div>
</div>

<script src="dist/iptools-jquery-accordion.min.js"></script>
<script type="text/javascript">
  $(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'
    });
  });
</script>

Options

NameDefaultTypeDescription
animationSpeed500intAnimation speed in miliseconds.
singleOpentruebooleanOnly one open panel at a time.
baseClassaccordionstringBase class of the accordion.
initializedClassaccordion--initializedstringClass added to the accordion after initialization.
panelClassaccordion__panelstringClass of panel.
panelActiveClassaccordion__panel--activestringClass of active panel.
triggerClassaccordion__triggerstringClass of trigger element.
triggerActiveClassaccordion__trigger--activestringClass of active trigger element.
contentClassaccordion__contentstringClass of content element.
contentActiveClassaccordion__content--activestringClass of active content element.

Data attributes

NameTypeDescription
data-accordion-panel-activatedbooleanDenotes active panel opened on plugin initilization. See also panelActiveClass option.

Events

Emitted events

EventEmitterDescription
initialized.iptAccordionwrapper / base elementOn successful plugin initialization
beforeOpen.iptAccordionindividual panelBefore panel is opened
afterOpen.iptAccordionindividual panelAfter panel has been opened (animation complete)
beforeClose.iptAccordionindividual panelBefore a panel is closed 
afterClose.iptAccordionindividual panelAfter panel has been closed (animation complete)

Subscribed events

EventAction
open.iptAccordionOpens panel
close.iptAccordionCloses panel
toggle.iptAccordionToggles panel

Licence

Copyright © 2015-2016 Interactive Pioneers GmbH. Licenced under GPL-3.