Bellows

Demo

Requirements

• Zepto
• Velocity.js

Velocity

If you are using Zepto, you need to load bower_components/velocity/velocity.js (this file comes with a jQuery shim bundled directly in it). If you are using jQuery, you need to load bower_components/velocity/jquery.velocity.js.

jQuery Support

Bellows supports jQuery but is not actively developed for it. You should be able to use Bellows directly with jQuery 2.0. While we don’t actively support jQuery for Bellows, we welcome any and all issues and PRs to help us make it work.

Installation

Bellows can be installed using bower:

bower install bellows

Usage with Require.js

To use with require.js, after installing through bower you merely have to reference bellows in your require config file:

{
    'paths': {
    	'plugin': 'bower_components/plugin/dist/plugin.min',
        'bellows': 'bower_components/bellows/dist/bellows.min',
        'velocity': 'bower_components/velocity/velocity'
    }
}

And then require bellows in as needed:

define(
    ['zepto', 'bellows'],
    function($) {
        $('.bellows').bellows();
    }
);

Usage

At a bare minimum, your markup structure should follow the above structure. You should have at least one bellows__item. Content within bellows__header and bellows__content can be whatever you want. You may also style either of those however you need. Our default theme will give you some standard styling for those sections but, if you want to theme Bellows yourself, we recommend not including the theme file and starting from scratch.

<!-- Include the CSS -->
<link rel="stylesheet" href="bellows.min.css">

<!-- Optionally include the Theme file -->
<link rel="stylesheet" href="bellows-style.min.css">

<!-- Include the markup -->
<div class="bellows">
    <!-- The Accordion Items -->
    <div class="bellows__item">
        <div class="bellows__header">
            <!-- Item Header - Content can be whatever you want -->
        </div>
        <div class="bellows__content">
            <!-- Item Content - Content can be whatever you want -->
        </div>
    </div>
    <div class="bellows__item">
        <div class="bellows__header">
            <h3>Header</h3>
        </div>
        <div class="bellows__content">
            <p>Content</p>
        </div>
    </div>
    <div class="bellows__item">
        <div class="bellows__header">
            <h3>Header</h3>
        </div>
        <div class="bellows__content">
            <p>Content</p>
        </div>
    </div>
</div>

<!-- Include dependencies -->
<script src="zepto.min.js"></script>
<script src="velocity.min.js"></script>

<!-- Include bellows.js -->
<script src="bellows.min.js"></script>

<!-- Construct Bellows -->
<script>$('.bellows').bellows()</script>

Initializing the plugin

bellows()

Initializes the bellows.

$('.bellows').bellows();

bellows(options)

Initialize with options.

$('.bellows').bellows({
    singleItemOpen: false,
    duration: 200,
    easing: 'swing',
    open: function(e, ui) {},
    opened: function(e, ui) {},
    close: function(e, ui) {},
    closed: function(e, ui) {}
});

Options

singleItemOpen

default: false

When set to true will force only one item open at a time.

$('.bellows').bellows({
    singleItemOpen: true
});

duration

default: 200

Sets the duration for the animation.

$('.bellows').bellows({
    duration: 600
});

easing

default: swing

Sets the easing for the animation. Bellows takes all of the same easing properties that Velocity.js accepts.

• jQuery UI’s easings and CSS3’s easings (“ease”, “ease-in”, “ease-out”, and “ease-in-out”), which are pre-packaged into Velocity. A bonus “spring” easing (sampled in the CSS Support pane) is also included.
• CSS3’s bezier curves: Pass in a four-item array of bezier points. (Refer to Cubic-Bezier.com for crafing custom bezier curves.)
• Spring physics: Pass a two-item array in the form of [ tension, friction ]. A higher tension (default: 600) increases total speed and bounciness. A lower friction (default: 20) increases ending vibration speed.
• Step easing: Pass a one-item array in the form of [ steps ]. The animation will jump toward its end values using the specified number of steps.

For more information, check out Velocity’s docs on easing.

$('.bellows').bellows({
    easing: 'ease-in-out'
});

open

default: function(e, ui) {}

Triggered every time the selected bellows item is starting to open.

Parameters

$('.bellows').bellows({
    open: function(e, ui) {
        // ui.item contains the item opening
    }
});

opened

default: function(e, ui) {}

Triggered every time the selected bellows item has finished opening.

Parameters

$('.bellows').bellows({
    opened: function(e, ui) {
        // ui.item contains the item that opened
    }
});

close

default: function(e, ui) {}

Triggered every time an bellows item is starting to close.

$('.bellows').bellows({
    close: function(e, ui) {
        // ui.item contains the item closing
    }
});

closed

default: function(e, ui) {}

Triggered every time an bellows item is finished closing.

$('.bellows').bellows({
    closed: function(e, ui) {
        // ui.item contains the item that closed
    }
});

Storing bellows object for future use

var $bellows = $('.bellows');

Methods

Open

Open the selected bellows item by element reference

$bellows.bellows('open', $('.bellows__item'));

or by index

$bellows.bellows('open', 1);

Close

Close the selected bellows item by element reference

$bellows.bellows('close', $('.bellows__item'));

or by index

$bellows.bellows('close', 1);

Browser Compatibility

Building a distribution

Requirements

• node.js 0.10.x/npm
• Grunt
  • Install with npm install -g grunt-cli
• Bower
  • Install with npm install -g bower

Steps

1. npm install
2. bower install
3. grunt build-dist

The dist directory will be populated with minified versions of the css and javascript files for distribution and use with whatever build system you might use. The src directory has our raw unminified Sass and Javascript files if you prefer to work with those.

License

MIT License. Bellows is Copyright © 2014 Mobify. It is free software and may be redistributed under the terms specified in the LICENSE file.