react-vir-tree

[![Travis][build-badge]][build]
[![npm package][npm-badge]][npm]
[![Coveralls][coveralls-badge]][coveralls]

[build-badge]: https://img.shields.io/travis/highqualitycode/react-vir-tree/master.png?style=flat-square
[build]: https://travis-ci.org/highqualitycode/react-vir-tree
[npm-badge]: https://img.shields.io/npm/v/react-vir-tree.png?style=flat-square
[npm]: https://www.npmjs.com/package/react-vir-tree
[coveralls-badge]: https://img.shields.io/coveralls/highqualitycode/react-vir-tree/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/highqualitycode/react-vir-tree

Introduction

react-vir-tree is a tree view react library built on top of react-virtualized

Its main goal is to display tree like data in a beautiful and fast way. Being a reactive library it uses children functions to achieve maximum extensibility. The core idea behind it is that anyone using it is enable to create a tree as they intent just by rendering their own components or components exported by the tree.

Demo and docs can be found in here.

Installation

You can install via npm or yarn.
npm i react-vir-tree --save

or

yarn add react-vir-tree

To get the basic styles for free you need to import react-virtualized styles only once.

``
import 'react-virtualized/styles.css'
import 'react-vir-tree/lib/main.css'
`

If you want to use the icons in the default renderers do the same for material icons.

import 'material-icons/css/material-icons.css'

Usage

To use the standalone tree

import Tree from 'react-vir-tree'

To use the FilteringContainer

import { FilteringContainer } from 'react-vir-tree'`

Dependencies

Most react-vir-tree Dependencies are managed internally, the only required peerDependencies are react, react-dom and react-virtualized.