Giter VIP home page Giter VIP logo

williamtroup / tree.js Goto Github PK

View Code? Open in Web Editor NEW
10.0 2.0 0.0 679 KB

๐ŸŒฒ A lightweight JavaScript library that allows you to create responsive and customizable interactive tree diagrams from an array of JS objects.

Home Page: https://www.william-troup.com/tree-js/

License: MIT License

Shell 0.16% JavaScript 54.66% SCSS 21.45% CSS 1.10% HTML 22.63%
javascript tree treemap css3 data grid html5 map visualization

tree.js's Introduction

Tree.js

Tweet npm nuget license discussions Welcome coded by William Troup

๐ŸŒฒ A lightweight JavaScript library that allows you to create responsive and customizable interactive tree diagrams from an array of JS objects.

v0.4.0


Tree.js - Gaps Tree.js - No Gaps Tree.js - Children Tree.js - Expanded

What features does Tree.js have?

  • Zero-dependencies and extremely lightweight!
  • Full API available via public functions.
  • Fully styled in CSS/SASS, fully responsive, and compatible with the Bootstrap library.
  • Full CSS theme support (using :root variables).
  • Fully configurable per DOM element.
  • Toggling data on/off support.
  • Customizable tooltips.
  • Expand/Contract data items.
  • Configurable colors for boxes!


What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What are the most recent changes?

To see a list of all the most recent changes, click here.

How do I install Tree.js?

You can install the library with npm into your local modules directory using the following command:

npm install jtree.js


How do I get started?

To get started using Tree.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<link rel="stylesheet" href="dist/tree.js.css">
<script src="dist/tree.js"></script>

3. DOM Element Binding:

<div id="tree-1" data-tree-options="{ 'showBoxGaps': true, 'data': [] }">
    Your HTML.
</div>

To see a list of all the available binding options you can use for "data-tree-options", click here.

To see a list of all the available custom triggers you can use for "data-tree-options", click here.


4. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Tree.js?

To customize, and get more out of Tree.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Tree.js will function. You can set them as follows:

<script> 
  $tree.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.

tree.js's People

Contributors

williamtroup avatar

Stargazers

Overu avatar  avatar Tane Piper avatar David Bisset avatar Olivier Refalo avatar Michael Scott Hertzberg avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.