395 lines
11 KiB
JavaScript
395 lines
11 KiB
JavaScript
'use strict';
|
|
|
|
import $ from 'jquery';
|
|
import { onLoad, GetYoDigits } from './foundation.core.utils';
|
|
import { Keyboard } from './foundation.util.keyboard';
|
|
import { Plugin } from './foundation.core.plugin';
|
|
|
|
/**
|
|
* Accordion module.
|
|
* @module foundation.accordion
|
|
* @requires foundation.util.keyboard
|
|
*/
|
|
|
|
class Accordion extends Plugin {
|
|
/**
|
|
* Creates a new instance of an accordion.
|
|
* @class
|
|
* @name Accordion
|
|
* @fires Accordion#init
|
|
* @param {jQuery} element - jQuery object to make into an accordion.
|
|
* @param {Object} options - a plain object with settings to override the default options.
|
|
*/
|
|
_setup(element, options) {
|
|
this.$element = element;
|
|
this.options = $.extend({}, Accordion.defaults, this.$element.data(), options);
|
|
|
|
this.className = 'Accordion'; // ie9 back compat
|
|
this._init();
|
|
|
|
Keyboard.register('Accordion', {
|
|
'ENTER': 'toggle',
|
|
'SPACE': 'toggle',
|
|
'ARROW_DOWN': 'next',
|
|
'ARROW_UP': 'previous'
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Initializes the accordion by animating the preset active pane(s).
|
|
* @private
|
|
*/
|
|
_init() {
|
|
this._isInitializing = true;
|
|
|
|
this.$element.attr('role', 'tablist');
|
|
this.$tabs = this.$element.children('[data-accordion-item]');
|
|
|
|
this.$tabs.each(function(idx, el) {
|
|
var $el = $(el),
|
|
$content = $el.children('[data-tab-content]'),
|
|
id = $content[0].id || GetYoDigits(6, 'accordion'),
|
|
linkId = (el.id) ? `${el.id}-label` : `${id}-label`;
|
|
|
|
$el.find('a:first').attr({
|
|
'aria-controls': id,
|
|
'role': 'tab',
|
|
'id': linkId,
|
|
'aria-expanded': false,
|
|
'aria-selected': false
|
|
});
|
|
|
|
$content.attr({'role': 'tabpanel', 'aria-labelledby': linkId, 'aria-hidden': true, 'id': id});
|
|
});
|
|
|
|
var $initActive = this.$element.find('.is-active').children('[data-tab-content]');
|
|
if ($initActive.length) {
|
|
// Save up the initial hash to return to it later when going back in history
|
|
this._initialAnchor = $initActive.prev('a').attr('href');
|
|
this._openSingleTab($initActive);
|
|
}
|
|
|
|
this._checkDeepLink = () => {
|
|
var anchor = window.location.hash;
|
|
|
|
if (!anchor.length) {
|
|
// If we are still initializing and there is no anchor, then there is nothing to do
|
|
if (this._isInitializing) return;
|
|
// Otherwise, move to the initial anchor
|
|
if (this._initialAnchor) anchor = this._initialAnchor;
|
|
}
|
|
|
|
var $anchor = anchor && $(anchor);
|
|
var $link = anchor && this.$element.find(`[href$="${anchor}"]`);
|
|
// Whether the anchor element that has been found is part of this element
|
|
var isOwnAnchor = !!($anchor.length && $link.length);
|
|
|
|
// If there is an anchor for the hash, open it (if not already active)
|
|
if ($anchor && $link && $link.length) {
|
|
if (!$link.parent('[data-accordion-item]').hasClass('is-active')) {
|
|
this._openSingleTab($anchor);
|
|
};
|
|
}
|
|
// Otherwise, close everything
|
|
else {
|
|
this._closeAllTabs();
|
|
}
|
|
|
|
if (isOwnAnchor) {
|
|
// Roll up a little to show the titles
|
|
if (this.options.deepLinkSmudge) {
|
|
onLoad($(window), () => {
|
|
var offset = this.$element.offset();
|
|
$('html, body').animate({ scrollTop: offset.top }, this.options.deepLinkSmudgeDelay);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Fires when the plugin has deeplinked at pageload
|
|
* @event Accordion#deeplink
|
|
*/
|
|
this.$element.trigger('deeplink.zf.accordion', [$link, $anchor]);
|
|
}
|
|
}
|
|
|
|
//use browser to open a tab, if it exists in this tabset
|
|
if (this.options.deepLink) {
|
|
this._checkDeepLink();
|
|
}
|
|
|
|
this._events();
|
|
|
|
this._isInitializing = false;
|
|
}
|
|
|
|
/**
|
|
* Adds event handlers for items within the accordion.
|
|
* @private
|
|
*/
|
|
_events() {
|
|
var _this = this;
|
|
|
|
this.$tabs.each(function() {
|
|
var $elem = $(this);
|
|
var $tabContent = $elem.children('[data-tab-content]');
|
|
if ($tabContent.length) {
|
|
$elem.children('a').off('click.zf.accordion keydown.zf.accordion')
|
|
.on('click.zf.accordion', function(e) {
|
|
e.preventDefault();
|
|
_this.toggle($tabContent);
|
|
}).on('keydown.zf.accordion', function(e){
|
|
Keyboard.handleKey(e, 'Accordion', {
|
|
toggle: function() {
|
|
_this.toggle($tabContent);
|
|
},
|
|
next: function() {
|
|
var $a = $elem.next().find('a').focus();
|
|
if (!_this.options.multiExpand) {
|
|
$a.trigger('click.zf.accordion')
|
|
}
|
|
},
|
|
previous: function() {
|
|
var $a = $elem.prev().find('a').focus();
|
|
if (!_this.options.multiExpand) {
|
|
$a.trigger('click.zf.accordion')
|
|
}
|
|
},
|
|
handled: function() {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
}
|
|
});
|
|
});
|
|
}
|
|
});
|
|
if(this.options.deepLink) {
|
|
$(window).on('hashchange', this._checkDeepLink);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Toggles the selected content pane's open/close state.
|
|
* @param {jQuery} $target - jQuery object of the pane to toggle (`.accordion-content`).
|
|
* @function
|
|
*/
|
|
toggle($target) {
|
|
if ($target.closest('[data-accordion]').is('[disabled]')) {
|
|
console.info('Cannot toggle an accordion that is disabled.');
|
|
return;
|
|
}
|
|
if($target.parent().hasClass('is-active')) {
|
|
this.up($target);
|
|
} else {
|
|
this.down($target);
|
|
}
|
|
//either replace or update browser history
|
|
if (this.options.deepLink) {
|
|
var anchor = $target.prev('a').attr('href');
|
|
|
|
if (this.options.updateHistory) {
|
|
history.pushState({}, '', anchor);
|
|
} else {
|
|
history.replaceState({}, '', anchor);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Opens the accordion tab defined by `$target`.
|
|
* @param {jQuery} $target - Accordion pane to open (`.accordion-content`).
|
|
* @fires Accordion#down
|
|
* @function
|
|
*/
|
|
down($target) {
|
|
if ($target.closest('[data-accordion]').is('[disabled]')) {
|
|
console.info('Cannot call down on an accordion that is disabled.');
|
|
return;
|
|
}
|
|
|
|
if (this.options.multiExpand)
|
|
this._openTab($target);
|
|
else
|
|
this._openSingleTab($target);
|
|
}
|
|
|
|
/**
|
|
* Closes the tab defined by `$target`.
|
|
* It may be ignored if the Accordion options don't allow it.
|
|
*
|
|
* @param {jQuery} $target - Accordion tab to close (`.accordion-content`).
|
|
* @fires Accordion#up
|
|
* @function
|
|
*/
|
|
up($target) {
|
|
if (this.$element.is('[disabled]')) {
|
|
console.info('Cannot call up on an accordion that is disabled.');
|
|
return;
|
|
}
|
|
|
|
// Don't close the item if it is already closed
|
|
const $targetItem = $target.parent();
|
|
if (!$targetItem.hasClass('is-active')) return;
|
|
|
|
// Don't close the item if there is no other active item (unless with `allowAllClosed`)
|
|
const $othersItems = $targetItem.siblings();
|
|
if (!this.options.allowAllClosed && !$othersItems.hasClass('is-active')) return;
|
|
|
|
this._closeTab($target);
|
|
}
|
|
|
|
/**
|
|
* Make the tab defined by `$target` the only opened tab, closing all others tabs.
|
|
* @param {jQuery} $target - Accordion tab to open (`.accordion-content`).
|
|
* @function
|
|
* @private
|
|
*/
|
|
_openSingleTab($target) {
|
|
// Close all the others active tabs.
|
|
const $activeContents = this.$element.children('.is-active').children('[data-tab-content]');
|
|
if ($activeContents.length) {
|
|
this._closeTab($activeContents.not($target));
|
|
}
|
|
|
|
// Then open the target.
|
|
this._openTab($target);
|
|
}
|
|
|
|
/**
|
|
* Opens the tab defined by `$target`.
|
|
* @param {jQuery} $target - Accordion tab to open (`.accordion-content`).
|
|
* @fires Accordion#down
|
|
* @function
|
|
* @private
|
|
*/
|
|
_openTab($target) {
|
|
const $targetItem = $target.parent();
|
|
const targetContentId = $target.attr('aria-labelledby');
|
|
|
|
$target.attr('aria-hidden', false);
|
|
$targetItem.addClass('is-active');
|
|
|
|
$(`#${targetContentId}`).attr({
|
|
'aria-expanded': true,
|
|
'aria-selected': true
|
|
});
|
|
|
|
$target.slideDown(this.options.slideSpeed, () => {
|
|
/**
|
|
* Fires when the tab is done opening.
|
|
* @event Accordion#down
|
|
*/
|
|
this.$element.trigger('down.zf.accordion', [$target]);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Closes the tab defined by `$target`.
|
|
* @param {jQuery} $target - Accordion tab to close (`.accordion-content`).
|
|
* @fires Accordion#up
|
|
* @function
|
|
* @private
|
|
*/
|
|
_closeTab($target) {
|
|
const $targetItem = $target.parent();
|
|
const targetContentId = $target.attr('aria-labelledby');
|
|
|
|
$target.attr('aria-hidden', true)
|
|
$targetItem.removeClass('is-active');
|
|
|
|
$(`#${targetContentId}`).attr({
|
|
'aria-expanded': false,
|
|
'aria-selected': false
|
|
});
|
|
|
|
$target.slideUp(this.options.slideSpeed, () => {
|
|
/**
|
|
* Fires when the tab is done collapsing up.
|
|
* @event Accordion#up
|
|
*/
|
|
this.$element.trigger('up.zf.accordion', [$target]);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Closes all active tabs
|
|
* @fires Accordion#up
|
|
* @function
|
|
* @private
|
|
*/
|
|
_closeAllTabs() {
|
|
var $activeTabs = this.$element.children('.is-active').children('[data-tab-content]');
|
|
if ($activeTabs.length) {
|
|
this._closeTab($activeTabs);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Destroys an instance of an accordion.
|
|
* @fires Accordion#destroyed
|
|
* @function
|
|
*/
|
|
_destroy() {
|
|
this.$element.find('[data-tab-content]').stop(true).slideUp(0).css('display', '');
|
|
this.$element.find('a').off('.zf.accordion');
|
|
if(this.options.deepLink) {
|
|
$(window).off('hashchange', this._checkDeepLink);
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
Accordion.defaults = {
|
|
/**
|
|
* Amount of time to animate the opening of an accordion pane.
|
|
* @option
|
|
* @type {number}
|
|
* @default 250
|
|
*/
|
|
slideSpeed: 250,
|
|
/**
|
|
* Allow the accordion to have multiple open panes.
|
|
* @option
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
multiExpand: false,
|
|
/**
|
|
* Allow the accordion to close all panes.
|
|
* @option
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
allowAllClosed: false,
|
|
/**
|
|
* Link the location hash to the open pane.
|
|
* Set the location hash when the opened pane changes, and open and scroll to the corresponding pane when the location changes.
|
|
* @option
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
deepLink: false,
|
|
/**
|
|
* If `deepLink` is enabled, adjust the deep link scroll to make sure the top of the accordion panel is visible
|
|
* @option
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
deepLinkSmudge: false,
|
|
/**
|
|
* If `deepLinkSmudge` is enabled, animation time (ms) for the deep link adjustment
|
|
* @option
|
|
* @type {number}
|
|
* @default 300
|
|
*/
|
|
deepLinkSmudgeDelay: 300,
|
|
/**
|
|
* If `deepLink` is enabled, update the browser history with the open accordion
|
|
* @option
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
updateHistory: false
|
|
};
|
|
|
|
export {Accordion};
|