Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
twitter bootstrap tree control
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
build
src
.gitignore
README.md
jakefile.js
package.json
vanity-shot.png

README.md

tbtree

A tree control for twitter bootstrap.

WARNING:This plugin is very much "alpha" and contains a number of hard-coded things that will change over time. Use at your own risk!

Dependencies

  • Twitter Bootstrap
  • jQuery
  • underscore.js
  • require.js (optional)

Features

  • displays data from an object literal as an expandable/collapsable tree
  • fires a custom event whenever a list item is clicked
  • looks like a Twitter Bootstrap control!

More features coming soon.

Usage

Assuming you have some data in a regular object literal structure:

var books = {
  'Science Fiction': [
    {
      title: 'Dune',
      author: 'Frank Herbert',
      rating: '5/5'
    },
    {
      title: "Ender's Game",
      author: 'Orson Scott Card',
      rating: '5/5'
    }
  ]
}

and assuming you have some DOM element where you want your tree to appear:

<div id="book-tree"></div>

the tree is initialized in code (probably in a jquery ready() callback) like this:

var tree = tbtree('#book-tree').load(books);

Events may be subscribed to like this:

tree.on('selected', function (e) {
  // where 'e' is a custom object
  // that will have some data related
  // to the list item that was selected
  console.log(e.path);
});

The following events are currently supported:

  • loaded: occurs when the tree has been loaded with data
  • selected: occurs when a node has been clicked on the tree
  • collapsed: occurs when a node has been collapsed
  • expanded: occurs when a node has been expanded

Of course, you can always subscribe to events via jQuery like normal:

$('#book-tree').on('click', 'li', function (e) {
  // a list element was clicked
});

Screenshots

vanity shot


The MIT License (MIT)

Copyright (c) 2012 Nicholas Cloud

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.

Something went wrong with that request. Please try again.