jQuery.tree enables automatic generation of "table of contents" -style lists.
jquery.tree.min.js from the GitHub repo, upload it to a server, and add it to your document's head:
jQuery.tree is available as a Bower package.
bower install jquery.tree --save
With no configuration (use sensible defaults):
Or, pass an options object:
.tree returns the generated list object, and so cannot be chained.
By default, the generated list is appended to the beginning of the target object. You can override this behavior with the
listContainer option, which can be any valid parameter to the jQuery constructor. Alternatively, you can set the
prepend option to false and manipulate the returned list object however you like in your own code.
To further specify which elements should appear in the list, use the
filter option, which accepts the same parameters as jQuery's
.filter. For instance, if you only want headers h1 and h2 to appear in your table of contents:
The default is
:header, which matches all header elements. A future release will allow the use non-header elements, but for now, only h1 through h6 elements are supported. (Non-headers won't break the plugin -- they just won't generate list items.)
- Improve scroll spy
- Improve the docs
- Add support for non-header elements
- Add unit tests
Copyright 2014 Parisleaf
Licensed under the MIT License