Tree navigation plugin for Twitter Bootstrap 3.0
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

readme.md

BootstrapTreeNav

http://morrissinger.github.io/BootstrapTreeNav

BootstrapTreeNav is a javascript plugin for Twitter Bootstrap 3 to help you create tree navigation menus, created and maintained by Morris Singer.

Example

Bootstrap Tree Nav by Morris Singer

Quick start

Clone the repo, git clone git://github.com/morrissinger/BootstrapTreeNav.git, or download the latest release.

Add CSS, or SASS to your project, as appropriate, and add JS. Also, add Font Awesome to your project, if you are not already including it with your installation of Twitter Bootstrap. Then, write your HTML:

 <ul class="nav nav-pills nav-stacked nav-tree" id="myTree" data-toggle="nav-tree">
     <li>
         <a href="http://www.example.com" target="_blank">Item One (With Children) (has link)</a>
         <ul class="nav nav-pills nav-stacked nav-tree">
             <li>
                 <a href="#">Item A (Without Children)</a>
             </li>
             <li>
                 <a href="#">Item B (Without Children)</a>
             </li>
             <li>
                 <a href="#">Item C (Without Children)</a>
             </li>
         </ul>
     </li>
     <li>
         <a href="#">Item Two (Without Children)</a>
     </li>
     <li>
         <a href="#">Item Three (With Children and Grandchildren)</a>
         <ul class="nav nav-pills nav-stacked nav-tree">
             <li>
                 <a href="#">Item A (With Children)</a>
                 <ul class="nav nav-pills nav-stacked nav-tree">
                     <li>
                         <a href="#">Item I (Without Children)</a>
                     </li>
                     <li>
                         <a href="#">Item II (Without Children)</a>
                     </li>
                     <li class="active">
                         <a href="#">Item III (Without Children)</a>
                     </li>
                 </ul>
             </li>
             <li>
                 <a href="#">Item B (Without Children)</a>
             </li>
             <li>
                 <a href="#">Item C (With Children)</a>
                 <ul class="nav nav-pills nav-stacked nav-tree">
                     <li>
                         <a href="#">Item I (Without Children)</a>
                     </li>
                     <li>
                         <a href="#">Item II (Without Children)</a>
                     </li>
                     <li>
                         <a href="#">Item III (Without Children)</a>
                     </li>
                 </ul>
             </li>
         </ul>
     </li>
 </ul>

Using the data API, you can also specify icons to display next to expanded and collapsed tree items:

  • data-nav-tree-expanded="icon-collapse-alt": Use the Font Awesome icon icon-collapse-alt next to expanded items.
  • data-nav-tree-collapsed="icon-expand-alt": Use the Font Awesome icon icon-expand-alt next to collapsed items.

Author

Morris Singer

Copyright and license

Copyright 2013 Morris Singer

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.