# treeview-component

> React TreeView for tree data structure representation

Latest version **2.0.1** (published 2022-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install treeview-component
pnpm add treeview-component
yarn add treeview-component
bun add treeview-component
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-05-02 |
| First published | 2020-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 59.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | pavloid21 |
| Maintainers | pavloid21 |
| Keywords | react, tree diagram, tree, treeview, tree-view, react-component, diagram |

## Links

- npm: https://www.npmjs.com/package/treeview-component
- Repository: https://github.com/pavloid21/treeview-component
- Homepage: https://github.com/pavloid21/treeview-component#readme
- Issues: https://github.com/pavloid21/treeview-component/issues
- npm.io page: https://npm.io/package/treeview-component

## Dependencies (2)

- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.182
- [react-easy-panzoom](https://npm.io/package/react-easy-panzoom.md) ^0.4.4

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-05-02
- 2.0.0 — 2022-05-01
- 1.0.4 — 2020-09-08
- 1.0.3 — 2020-09-07
- 1.0.2 — 2020-09-07
- 1.0.1 — 2020-08-26
- 1.0.0 — 2020-08-26

## README

# treeview-component

> TreeView for tree data structure representation

[![NPM](https://img.shields.io/npm/v/treeview-component.svg)](https://www.npmjs.com/package/treeview-component) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![DemoImage](Screenshot_7.png)

## Install

```bash
npm install --save treeview-component
```

## Properties
|Name|Description|
|---|---|
|nodeView|component which will represent as non-empty vertex|
|nodeViewClasses|imported styles for vertex|
|showEmptyNodes|boolean flag for showing empty vertexes|
|emptyNode|component which represent empty vertex|
|emptyNodeProps|properties for empty vertexes component|
|tree|object of tree structure for visualization|

## Usage

[Live demo](https://treeview-component.vercel.app/)

```jsx
import React, { useState } from 'react'

import { TreeView, TreeViewProps, TreeNode } from 'treeview-component'
import NodeView from './components/NodeView'
import EmptyNode from './components/EmptyNode'
import 'treeview-component/lib/esm/src/styles.module.css'
import styles from './classes.module.css'

const App: React.FC<any> = () => {
  const [tree, setTree] = useState<TreeNode>({
    node: '00',
    parent_node: null,
    title: 'First node',
    description: 'Some description for node.',
    children: [
      {
        node: '10',
        parent_node: '00',
        title: 'Second node',
        description: 'Some description for node.',
        children: [null]
      },
      {
        node: '11',
        parent_node: '00',
        title: 'Third node',
        description: 'Some description for node.',
        children: [null, null]
      }
    ]

  });

  const addCardFunc = (node: TreeNode, newTree: TreeNode) => {
    let tree = { ...newTree };
    const walker = (cell: TreeNode | null) => {
      if (!cell) {
        return
      }
      cell.children.forEach((child: TreeNode | null, id: number) => {
        if (child?.node === node.node) {
          cell.children[id] = {
            node: child.node,
            parent_node: cell.node,
            title: 'Added node',
            description: 'This node was added by click',
            children: [null, null],
          }
        }
        walker(child)
      })
    }
    walker(tree)
    setTree(tree)
  }

  const addCard = (event: React.MouseEvent<HTMLElement, MouseEvent>, data: { node: TreeNode, newTree: TreeNode }) => {
    addCardFunc(data.node, data.newTree);
  }

  const treeProps: TreeViewProps = {
    autoCenter: true,
    nodeView: NodeView,
    nodeViewClasses: styles,
    showEmptyNodes: true,
    emptyNode: EmptyNode,
    emptyNodeProps: {
      onClick: addCard,
      className: styles.add_card
    },
    tree,
    style: {
      cursor: 'auto',
      outline: 'none'
    }
  }

  return (
    <div className="wrapper">
      <TreeView {...treeProps} />
    </div>
  )

}

export default App
```

## License

MIT © [pavloid21](https://github.com/pavloid21)

---
_Source: https://npm.io/package/treeview-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._