Tree view

Bootstrap 5 Tree view plugin

MDB treeview plugin is used to show hierarchical information which starts from the root item and proceed to its children and their respective children. Each item besides the root has a parent and can have children.

The parent is the node which is higher in the hierarchy and the child the one that is lower. Siblings are items which have one and the same parent. Items can be expanded and collapsed.

Note: Read the API tab to find all available options and advanced customization

Basic example - DOM

Add .treeview class to the container with your list to initialize the component structure. If you want to nest your lists - wrap a text of a li tag in a tag and define other ul after it. Add .show class to the list that you want to expand from the beginning.

Basic example - JavaScript

You can define whole structure of tree using only JavaScript. There are some props in data that you can use to customize it:

  • name - defines a text for an item
  • children - defines a nested list and it's children
  • icon - defines a custom expanding icon for the nested list
  • show - defines if list expands from the beginning or not
  • disabled - defines if list item is disabled or not

Open on item click

Use a data-mdb-open-on-click to define opening lists of treeview by click only on the arrow or on the whole list item.

Accordion

Use a data-mdb-accordion attribute to enable or disable opening only one list at the same level.

Selectable

Use a data-mdb-selectable attribute to set up checkboxes in every list item.

Expand

Expand your treeview to the particular list using the expand(ID) method.

Collapse

Collapse your treeview using the collapse() method.

Custom icons - DOM

You can add your custom icons to your treeview. For non-nested elements - paste code of an icon in the item. For nested elements - declare span tag with aria-label="toggle" attribute inside a element and paste there the code for your icon.

Use a data-mdb-rotation-angle attribute to define a rotation angle of nested lists icons.

Custom icons - JavaScript

Add icons to the list elements by pasting an icon code in the name property. If you want to change the rotatable icon in the nested list - use icon property instead.

Color

Set the color of an active item using the data-mdb-treeview-color attribute.

Current color: primary

Line

Use a data-mdb-line attribute to set up an additional line in every nested list.

Disabled - DOM

Add .treeview-disabled class to the a (if nested) or li tag to disable your list item. You can expand disabled items, but you can't select them.

Disabled - JavaScript

To generate a disabled list item, use disabled property.

Filter

Use the .filter(string) method to expand list items that meet your requirements.

Tree view - API

Usage

Via class


        <div class="treeview">
          <ul>
            <li>One</li>
            <li>Two</li>
            <li>
              <a>Three</a>
              <ul>
                <li>Second-one</li>
                <li>Second-two</li>
                <li>Second-three</li>
              </ul>
            </li>
          </ul>
        </div>

Via JavaScript


        var myTreeview = new Treeview(document.getElementById('myTreeview'), {
          structure: [
            {name: 'One'},
            {name: 'Two'},
            {name: 'Three', children: [
              {name: 'Second-one'},
              {name: 'Second-two'},
              {name: 'Second-three'}
            ]},
          ]
        });

Via jQuery

Note: By default, MDB does not include jQuery and you have to add it to the project on your own. 


        $('.example-class').treeview(options);

Options

Name Type Default Description
treeviewColor String 'primary' Defines a text and background color for an active or hovered item
openOnClick Boolean true Enables opening list by clicking only on the icon
selectable Boolean false Setup checkboxes for the every list item
accordion Boolean false Allows only one list on the same level to be opened
rotationAngle Number 90 Defines a rotation angle of the icons in nested lists
line Boolean false Adds a line to every nested list

Methods

Name Description Example
dispose Destroys a Treeview instance myTreeview.dispose()
getInstance Static method which allows you to get the tree view instance associated to a DOM element. Treeview.getInstance(myTreeviewEl)
collapse Collapses every list in treeview myTreeview.collapse()
expand('level-id') Expands a treeview to the list with a particular ID myTreeview.expand('level-sampleItems')
filter(string) Expands list items that meet your requirements myTreeview.filter('sample') 

        var myTreeviewEl = document.getElementById('myTreeview'); 
        var treeview = new Treeview(myTreeviewEl);
        treeview.collapse();

Events

Name Description
select.mdb.treeview This event fires immediately when one of the treeview checkboxes are changed. Selected items are available with items property of the event.
activeItem.mdb.treeview This event fires immediately when one of the treeview list items are selected by click. Selected item is available with item property of the event. 

        var myTreeviewEl = document.getElementById('myTreeview')
        myTreeviewEl.addEventListener('select', function (e) {
          // do something...
        })

Import

MDB UI KIT also works with module bundlers. Use the following code to import this component: 


        import Treeview from 'mdb-treeview';