feat: tree bubble #639
feat: tree bubble #639
Conversation
dlvhdr
force-pushed
the
dlvhdr/tree-bubble
branch
from
e32c664
to
0addf7c
Compare
tree/tree.go
Outdated
| // Node implements lipgloss's tree.Node | ||
| type Node struct { | ||
| // tree is used as the renderer layer | ||
| tree *ltree.Tree |
There was a problem hiding this comment.
I'm thinking whether I should implement everything here, and not use lipgloss.Tree because:
- I'm using lipgloss.Tree as a renderer, but I found myself implementing a lot of its logic.
- I've also found that the
tablebubble doesn't actually uselipgloss.Table - I needed more granular styling like the notion of a selected node, which
lipgloss.Treedoesn't "natively" support, so I wasn't sure if what I'm doing is an abuse. - I would also need to expose everything
lipgloss.Treeexports like all the different Enumerator styles and the rest.
Let me know what you think. Should the view function also be implemented here and not use lipgloss.Tree.View()?
There was a problem hiding this comment.
Ideally, we use lipgloss/tree for rendering. If it doesn't support what we need we can get it there.
So for some background, the table/bubble predates lipgloss.Table, but the plan was always to migrate to Lip Gloss for rendering as lipgloss/table, which is much, much more robust than the Bubbles implementation.
tree/tree.go
Outdated
| // IsSelected returns whether this item is selected. | ||
| func (t *Node) IsSelected() bool { | ||
| return t.yOffset == t.opts.treeYOffset | ||
| } | ||
|
|
||
| // Depth returns the depth of the node in the tree. | ||
| func (t *Node) Depth() int { | ||
| return t.depth | ||
| } | ||
|
|
||
| // Size returns the number of nodes in the tree. | ||
| // Note that if a child isn't open, its size is 1 | ||
| func (t *Node) Size() int { | ||
| return t.size | ||
| } | ||
|
|
||
| // YOffset returns the vertical offset of the Node | ||
| func (t *Node) YOffset() int { | ||
| return t.yOffset | ||
| } |
There was a problem hiding this comment.
These can be used to allow for more flexible styling.
I found the StyleFunc of lipgloss.Tree doesn't support some stuff I want, like appending a symbol to the end of each item at the same indentation to the right of it. Maybe there are more use cases.
tree/tree.go
Outdated
| } | ||
|
|
||
| // Used to print the Node's tree | ||
| // TODO: Value is not called on the root node, so we need to repeat the open/closed character |
There was a problem hiding this comment.
Here I found I needed to implement the String() func to repeat the open/close character logic because the Value() func isn't called on the root. Maybe this is an easy fix in lipgloss.
tree/tree.go
Outdated
| func (t *Node) GivenValue() any { | ||
| return t.value | ||
| } |
There was a problem hiding this comment.
This was helpful in the TOC example I think. I found that the tree "swallows" my values and I can't read them again. This forces the user to save them before passing to the tree, which is just duplication and not the most ergonomic API. The name is confusing though given the Value() func also exists due to the Node interface from lipgloss.
A ValueFunc, similar to the StyleFunc could also solve this, as I believe that was my usecase.
tree/tree.go
Outdated
| func (t *Node) Children() ltree.Children { | ||
| return t.tree.Children() | ||
| } |
There was a problem hiding this comment.
This exposes lipgloss as it has to return lipgloss.Children since that's the interface
Introduces a tree bubble for TUIs that require a tree like model with expand/collapse/select functionality.
Screen.Recording.2024-10-25.at.17.31.24.mov
Intended Interactions
API
lipgloss.Treefor the renderingSelectedNode()SetSelectedNode()YOffsetin a getter so users can scroll to a nodedepthin a getterExample Usage
See charmbracelet/bubbletea#1190
Closes #233.