toggles.js: Collapsible Content

DEPRICATION WARNING: the functionality in this script has been superceeded / trivialised by updated web standards.

A collapsing "accordion" list to be used as an FAQ and a collection of content grouped together into tabs.

How to include the script

The stylesheet is best included in the header of the document.

<link rel="stylesheet" href="./css/toggles-accordion.css"/>
<link rel="stylesheet" href="./css/toggles-tabs.css"/>

This include can be added to the header or placed inline before the script is invoked.

<script src="lib/transitions.js"></script>
<script src="js/toggles.js"></script>

Or use Require.js.

requirejs([
	'lib/transitions.js',
	'js/toggles.js'
], function(transitions, Toggles) {
	...
});

Or use imported as a component in existing projects.

@import {transitions = require('lib/transitions.js";
@import {Toggles} from "js/toggles.js";

How to start the script

Using vanilla JavaScript

var toggles = new Toggles({
	'elements' : document.querySelectorAll('dl.accordion'),
	'buttons' : 'dt',
	'classes' : {
		'active' : 'accordion_active',
		'passive' : 'accordion_passive',
		'open' : 'accordion_open',
		'closed' : 'accordion_closed'
	},
	'grouped' : false,
	'toggle' : true,
	'index' : -1
});

elements : {DOM objects} - A collection of DOM objects to be affected by the script.

id : {string} - The ID attribute of an element somewhere in the document.

grouped : {boolean} - Determines if opening one content area, causes the rest to close.

toggle : {boolean} - Determines if content areas can be closed as well as opened by the same button.

index : {integer} - Controls which toggle is active by default.

auto : {integer} (not implemented yet) - The interval in milliseconds of the automatic cycle.

classes : {object} - Collection of class names for the operation of the script.

• active : {string} - The class name used to highlight toggle buttons.
• passive : {string} - The class name used for the default state of the toggle buttons.
• open : {string} - The class name that displays the content in an open state.
• closed' : {string} - The class name that displays the content in a closed state.

How to control the script

Focus

toggles.instances[number].focus(index);

Activates a specific toggle element.

number : {integer} - The instance number of the script.

index : {integer} - The index of the thumbnail to centre and highlight.

License

This work is licensed under a MIT License. The latest version of this and other scripts by the same author can be found on Github.