# react-native-final-tree-view

> A React Native tree view component!

Latest version **3.0.0** (published 2021-12-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-final-tree-view
pnpm add react-native-final-tree-view
yarn add react-native-final-tree-view
bun add react-native-final-tree-view
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-12-09 |
| First published | 2018-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 49 |
| Author | Luis Felipe Zaguini |
| Maintainers | zaguini |
| Keywords | react, react-native, react-component, react-native-tree-view, react-native-final-tree-view, tree-view, tree, view |

## Links

- npm: https://www.npmjs.com/package/react-native-final-tree-view
- Repository: https://github.com/zaguiini/react-native-final-tree-view
- Issues: https://github.com/zaguiini/react-native-final-tree-view/issues
- npm.io page: https://npm.io/package/react-native-final-tree-view

## Dependencies (1)

- [lodash.get](https://npm.io/package/lodash.get.md) ^4.4.2

## 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

- 3.0.0 (latest) — 2021-12-09
- 3.0.0-beta.0 (beta) — 2021-12-08
- 2.0.0-beta.0 — 2021-12-08
- 2.1.0 — 2020-11-17
- 2.0.3 — 2020-04-15
- 2.0.2 — 2020-03-31
- 2.0.1 — 2019-09-24
- 2.0.0 — 2019-08-15
- 1.2.0 — 2019-08-02
- 1.1.0 — 2019-02-16
- 1.0.0 — 2018-12-06

## README

# react-native-final-tree-view

A React Native Tree View component!

## Installation

`yarn add react-native-final-tree-view`

## Usage

Firstly, you have to define your data. Example:

```js
const family = [
  {
    id: 'Grandparent',
    name: 'Grandpa',
    age: 78,
    children: [
      {
        id: 'Me',
        name: 'Me',
        age: 30,
        children: [
          {
            id: 'Erick',
            name: 'Erick',
            age: 10,
          },
          {
            id: 'Rose',
            name: 'Rose',
            age: 12,
          },
        ],
      },
    ],
  },
]
```

It is required that each node on the tree have its own `id` key. Obviously, it should be **unique**.
The tree nodes are defined in the `children` key.
They are an array of objects, following the same structure as the parent.

After defining your data, mount the component. Example:

```js
import React from 'react'
import { Text, View } from 'react-native'

import TreeView from 'react-native-final-tree-view'

function getIndicator(isExpanded, hasChildrenNodes) {
  if (!hasChildrenNodes) {
    return '-'
  } else if (isExpanded) {
    return '\\/'
  } else {
    return '>'
  }
}

function App() {
  return (
    <TreeView
      data={family} // defined above
      renderNode={({ node, level, isExpanded, hasChildrenNodes }) => {
        return (
          <View>
            <Text
              style={{
                marginLeft: 25 * level,
              }}
            >
              {getIndicator(isExpanded, hasChildrenNodes)} {node.name}
            </Text>
          </View>
        )
      }}
    />
  )
}

export default App
```

This should display:

![First render](https://i.imgur.com/LWDr9Ba.png)

And, after a few touches:

![All expanded](https://i.imgur.com/lEWGnIW.png)

## Props

### `data`

**Required**. The tree data to render. It's an array of objects.
Each object should have, at least, the `id` of the node and the `children` of it.
This structure can be changed via the props `idKey` and `childrenKey`, respectively.

### `renderNode`

**Required**. A function that must return the JSX to render the item. Signature:

```js
renderNode({ node, level, isExpanded, hasChildrenNodes })
```

Example:

```js
function getIndicator(isExpanded, hasChildrenNodes) {
  if (!hasChildrenNodes) {
    return '-'
  } else if (isExpanded) {
    return '\\/'
  } else {
    return '>'
  }
}

renderNode={({ node, level, isExpanded, hasChildrenNodes }) => (
  <View>
    <Text
      style={{
        marginLeft: 25 * level,
      }}
    >
      {getIndicator(isExpanded, hasChildrenNodes)} {node.name}
    </Text>
  </View>
)}
```

### `onNodePress`

Optional. A callback fired when a node is pressed. Signature:

```js
onNodePress({ node, level })
```

It accepts a promise if you want. If you **DON'T** want the specific node to expand or collapse, return `false` at the end of this event!!!

### `onNodeLongPress`

Optional. A callback fired when a node is long pressed. Signature:

```js
onNodeLongPress({ node, level })
```

### `isNodeExpanded`

Optional. Used for custom handling of expanded nodes. Signature:

```js
isNodeExpanded(id)
```

### `idKey`

Optional. The `id` key to refer to. Defaults to `id`

### `childrenKey`

Optional. The `children` key to look for. Defaults to `children`

### `activeOpacityNode`

Optional. The opacity of the wrapped node. Defaults `0.2`

### `initialExpanded`

If nodes should start expanded. Defaults to `false`

## FAQ

### If I modify the `data` prop does it reflect the changes without collapsing the nodes?

No. Once you modify the data, the whole tree goes back to `initialExpanded`

### Are PRs open?

Yes! Feel free to contribute!

## License

MIT

---
_Source: https://npm.io/package/react-native-final-tree-view · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._