Giter Club home page Giter Club logo

jstree's Introduction

Please use the stable version until the docs for v.1.0.0 are ready.

Older releases can be found on [google code][older] [older]: http://code.google.com/p/jstree/downloads/list

jstree

Tree view for jQuery.

A list of useful pages:

Getting Started

Download the production version or the development version.

###In your web page:

<script src="libs/jquery/jquery.js"></script>
<script src="dist/jstree.min.js"></script>
<script>
jQuery(function($) {
  $('#container').jstree(
    /* put optional options for each plugin here, will extend the defaults */
    core : { /* core options go here */ },
    /* specify which plugins you want, you may omit this too */
    plugins : [ "themes", "html_data", "some-other-plugin" ]
  );
});
</script>

###Interacting with the tree:

/* METHOD ONE */
jQuery("some-selector-to-container-node-here")
  .jstree("operation_name" [, argument_1, argument_2, ...]);

/* METHOD TWO */
jQuery.jstree._reference(needle)
  .operation_name([ argument_1, argument_2, ...]);

###Events: jsTree uses events to notify of any changes. All events fire on the tree container in the jstree namespace and are named after the function that triggered them.

jQuery("some-container")
  .jstree({ /* configuration here */ })
  .bind("__ready.jstree", function (event, data) {
    alert("TREE IS LOADED");
    /* note the second parameter, read the docs on each event for its value */
  })

###Data:

TODO: a step by step guide to: HTML (no data plugin), HTML with plugin + AJAX, JSON, JSON + AJAX, XML, XML + AJAX, explain progressive render / unload

###States:

TODO: explain about passing states along with the data and the special data-jstree- attributes.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!

License

Copyright (c) 2012 Ivan Bozhanov (http://vakata.com)

Licensed under the MIT, GPL licenses.

jstree's People

Contributors

vakata avatar ehsan avatar

Watchers

 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.