Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 3.76 KB

README.md

File metadata and controls

89 lines (70 loc) · 3.76 KB
Raw

react-d3-treemap

TreeMap component built with D3 Treemap and React based on Mike Bostock´s Treemap.

npm version Code Climate PRs Welcome

NPM

React-d3-treemap-gif

DEMO

React D3 Treemap demo

Features

Installation

Steps to use react-d3-treemap in your React project

1.Install from NPM

npm install --save react-d3-treemap

2. Import and use in your application

import TreeMap from "react-d3-treemap";
// Include its styles in you build process as well
import "react-d3-treemap/dist/react.d3.treemap.css";

3. Usage

  <TreeMap
      height={500}
      width={800}
      data={data}
      valueUnit={"MB"}
  />

Data sample

You can see an example of data here.

TypeScript sample

I created a TypeScript consume sample for React D3 Treemap.

TODOs

License

BSD 3-Clause License

Copyright (c) 2017, José Quinto (https://blog.josequinto.com) All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.