beefup v1.5.0

BeefUp

Just a jQuery accordion plugin

https://schascha.github.io/BeefUp/

Examples:

• Toggle buttons
• Hashchange
• CSS animations
• Self block

Installation

You can use BeefUp in your project by installing it using npm:

npm install beefup --save

Usage

1. Include jQuery

   <script src="dist/js/jquery.min.js"></script>

2. Include plugin

   <script src="dist/js/jquery.beefup.min.js"></script>

3. Add styles

   <link rel="stylesheet" href="dist/css/jquery.beefup.css">

4. Add markup

   <article class="beefup">
       <h2 class="beefup__head">Headline</h2>
       <div class="beefup__body">My fancy collapsible content.</div>
   </article>

5. Call the plugin

   <script>
       $(function() {
           $('.beefup').beefup();
       });
   </script>

Configuration

Advanced

API Methods

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

Open

$beefup.open($('#beefupID'));

Close

$beefup.close($('#beefupID'));

Click

$beefup.click($('#beefupID'));

Scroll

$beefup.scroll($('#beefupID'));

Callbacks

$('.beefup').beefup({
    onInit: function ($this) {
        // Do something after initially setup
    },
    onOpen: function ($this) {
        // Do something after accordion open the content
    },
    onClose: function ($this) {
        // Do something after accordion close the content
    },
    onScroll: function ($this) {
        // Do something after scroll animation
    }
});

HTML5 data attributes

<article class="beefup" data-beefup-options='{"animation": "", "openSpeed": 800}'>
    ...
</article>

Bugs? 🐛

Please let me know: https://github.com/Schascha/BeefUp/issues

Buy me a Coffee ☕

Support this project and others via PayPal. Thanks

Changelog

Detailed changes for each release are documented in the release notes.

License

MIT

Copyright (c) 2014-present Sascha Künstler