tui-realm-treeview
Developed by Christian Visintin
Current version: 0.1.0 (06/06/2021)
About tui-realm-treeview 🌲
tui-realm-treeview is an implementation of a treeview component for tui-realm, it is implemented wrapping the tui-tree-widget
Get started 🏁
Add tui-realm-treeview to your Cargo.toml 🦀
= "0.1.0"
Use the treeview component
View how to use the treeview-component following the example. The example contains a simple file explorer using a tree view, the depth is set to 3.
- Press
ENTER
to change directory - Press
BACKSPACE
to go to upper directory - Move up and down with
UP/DOWN
arrow keys - Open directories with
RIGHT
- Close directories with
LEFT
- Change window between input field and treeview with
TAB
- Press
ESC
to quit
About performance
In this library there is a consistent use of recursion, and since rust is not functional, this might lead to stack overflows when dealing with huge trees. In addition consider that each level of depth added, will slow down the application exponentially.
Best practices:
- Except when dealing with small trees, always set a depth for the tree
- For file systems, depth 3 should be fine
Documentation 📚
The developer documentation can be found on Rust Docs at https://docs.rs/tui-realm-treeview
Contributing and issues 🤝🏻
Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve tui-realm, feel free to open an issue or a PR.
Please follow our contributing guidelines
Changelog ⏳
View tui-realm-treeview's changelog HERE
Buy me a coffee ☕
If you like tui-realm-treeview and you're grateful for the work I've done, please consider a little donation 🥳
License 📃
tui-realm is licensed under the MIT license.
You can read the entire license HERE