boxlet v0.0.6

boxlet

(c)Bumblehead, 2014,2015 MIT-license

Overview:

Scripted open/shut behaviour for transitioned box content. Behaviour is customizable but specific markup is required. Behaviours may include animated changes to background and foreground color, opacity, size and visibility.

Animated content activity of one box (note that titles are animatable also):

Mulitple box animations may be coordinated as well:

Boxlet does not use CSS3. It modifies each element with beast.js. An advantage is that multiple animations may be synchronised and callbacks may be used when they complete.

For tablets, phones and older IE browsers... in many use-cases beast performs with no observable 'choppiness'. If choppiness is experienced try more conservative frames and fps values.

Boxlet originates from a single-page checkout developed for Ties.com. Shipping, billing etc -each stage of the checkout process used a different box -this increased conversions.

Install:

boxlet may be downloaded directly or installed through npm.

• npm

  $ npm install boxlet

• Direct Download

  $ git clone https://github.com/iambumblehead/boxlet.git

Boxlet is meant to be npm-installed and deployed with scroungejs. Alternatively, this repository contains two ready-to-use files, boxlet.min.js and boxlet.unmin.js.

Run npm start to build a sample boxlet page and to see an advanced component constructed around boxlet as an example.

Test:

Tests are not automated and are performed by loading a document in the browser and using the browser console.

• load test/index.html in your browser and run tests from the console.

GET STARTED:

The demo boxlet uses the following markup:

<div id="Boxlet" class="boxlet st-content-preview">
  <div id="BoxTitle" class="boxlet-title">
    title
  </div>

  <div id="BoxContentPrev" class="boxlet-content-preview st-show-open">
    <div class="boxlet-content-preview-bd">
      <p>content</p>
    </div>
  </div>

  <div id="BoxContentFull" class="boxlet-content-main st-show-shut">
    <div class="boxlet-content-main-bd">
      content main
    </div>
  </div>
</div>

When markup is available in the document, include boxlet scripts and call them:

var boxlet1 = boxlet({
    boxId : 'Boxlet',
    boxTitleId : 'BoxTitle',
    boxContentFullId : 'BoxContentFull',
    boxContentPrevId : 'BoxContentPrev'
});

For synchronized boxlet animation see the test files.

License:

(The MIT License)

Copyright (c) 2014 [Bumblehead][0] <chris@bumblehead.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.