An open API service indexing awesome lists of open source software.

https://github.com/novident/novident-tree-view

Novident library for visualizing hierarchical structures with full control over nodes.
https://github.com/novident/novident-tree-view

nodes novident tree tree-structure tree-view widgets

Last synced: 9 months ago
JSON representation

Novident library for visualizing hierarchical structures with full control over nodes.

Awesome Lists containing this project

README

          

# 🌳 Novident Tree View


Image of Novident Tree View example

This package provides a flexible solution for displaying hierarchical data structures while giving developers full control over node management. Unlike traditional tree implementations that enforce controller-based architectures, this package operates on simple data types that you extend to create your node hierarchy. Nodes become self-aware of their state changes through `Listenable` patterns, enabling reactive updates without complex state management.

## 💡 Motivation

We've investigated several alternatives that allow for convenient node tree creation with a standards-compliant implementation. But, we couldn't find one that satisfies our requirements. Most of these implementations required initializing a controller or similar to allow for a proper flow of actions within the tree.

However, for **Novident**, this isn't what we're looking for. Our goal is to create a common solution that allows us to:

* Listen for changes to Nodes manually
* Send or force updates to specific Nodes
* Have a common operation flow (insert, delete, move, or update) for nodes within the tree that depends on the user's implementation and not the package (complete control over them)
* Better support for Node configuration

This is why we decided to create this package, which adds everything **Novident** requires in one place.

In this package, we can simply add a few configurations and leave everything else to it, as our own logic can create a beautiful file/node tree without too much code or the need for drivers.

## 📦 Installation

Add to your `pubspec.yaml`:

```yaml
dependencies:
novident_tree_view:
novident_nodes:
```

## Basic usage

```dart
import 'package:novident_tree_view/novident_tree_view.dart';

final Widget tree = TreeView(
root: yourRootContainer,
configuration: TreeConfiguration(
components: [MyNodeBuilder(), AnotherNodeBuilder()],
draggableConfigurations: DraggableConfigurations(/*...*/),
indentConfiguration: IndentConfiguration.basic(/*...*/),
onHoverContainer: (node) => debugPrint('Hovering: ${node.details.id}'),
activateDragAndDropFeature: !kIsWeb, // Disable on web
addRepaintBoundaries: true,
),
);

```

## 🔎 Resources

Since there's a lot to explain and implement, we prefer to provide a separate document for each section to explain more concretely and accurately what each point entails.

* [📲 Components](https://github.com/Novident/novident-tree-view/blob/master/doc/components.md): In this section, we explain what a `NodeComponentBuilder` (which is responsible for rendering nodes) is, and how you can create your own versions so you can create your own implementations of each Node.

* [🌲 Tree Configuration](https://github.com/Novident/novident-tree-view/blob/master/doc/tree_configuration.md): In this section, we explain what a `TreeConfiguration` is and all the properties that allow this package to render and use your Nodes to show a more effective appearance that simulates a node tree.

* [🤏 Draggable Configurations](https://github.com/Novident/novident-tree-view/blob/master/doc/draggable_configuration.md): In this section, we explain what a `DraggableConfiguration` is, and how you can use it to configure the visual appearance of your nodes during Drag and Drop events.

* [📏 Indentation Configuration](https://github.com/Novident/novident-tree-view/blob/master/doc/indentation_configuration.md): In this section, we explain what an `IndentConfiguration` is, and how you can use it to add indentation to your nodes in a simple yet effective way.

* [📜 Drag and Drop details](https://github.com/Novident/novident-tree-view/blob/master/doc/drag_and_drop_details.md): In this section, we explain what a `NovDragAndDropDetails` is, and what it is typically used for (and even how it is used internally to calculate certain positions during drag and drop events).

* [✍️ Nodes Gestures](https://github.com/Novident/novident-tree-view/blob/master/doc/nodes_gestures.md): In this section, we explain what a `NodeDragGestures` is and how you can configure it quickly and easily.

## 📝 Recipes

* [🗃️ Tree File](https://github.com/Novident/novident-tree-view/blob/master/doc/recipes/tree_file/tree_file.md): We designed an example of how you could recreate a file tree using this package quickly and easily, without too much code, but that allows you to simulate the standard behaviors of a file tree.

_More recipes will be added later_

## 🌳 Contributing

We greatly appreciate your time and effort.

To keep the project consistent and maintainable, we have a few guidelines that we ask all contributors to follow. These guidelines help ensure that everyone can understand and work with the code easier.

See [Contributing](https://github.com/Novident/novident-tree-view/blob/master/CONTRIBUTING.md) for more details.