bubbleboxer

README

bubbleboxer 🥊 - compose bubbles into boxes 📦

A way to compose multiple bubbles into one layout.

To layout the bubbles with bubbleboxer, one would construct a layout-tree 🌲. Each node holds a arbitrary amount of children as well as the orientation (horizontal/vertical) and the spacing of them. Each leaf is linked (via an address) to one Model which satisfies the bubbletea Model-interface. With this address one can access this Models and change them independently from the layout-tree.

 1╭>list of something │ some    0 │ a                       V
  │ ----------------- │ status  1 │  text                  / \
 2├ which you may     │ infor-  2 │   logo                /   \
  │ edit as you wish  │ mation  4 │    even!             H    l5
 3├ or just use it    │           │                     / \
 4├ to display        │ l2        │ l3                 /   \
 5├ and scroll        │──────────────────────         l1    V
                      │ Maybe here is a                    / \
                      │ note written to each              /   \
                      │ list entry, in a                 H    l4
                      │ bubbles viewport.               / \
                      │                                /   \
 l1                   │ l4                            l2   l3
─────────────────────────────────────────────
 maybe a progressbar or a command input? 100% 

 l5

// TODO write about the need for embedding boxer into a other model and about nobordernodes beeing non recursive

LICENSE

MIT

Documentation

Index

• Constants
• type Layout
  • func NewLayout(root Node, logger *slog.Logger) *Layout
  • func (b *Layout) AddLeaf(address string, model tea.Model) (Node, error)
  • func (b *Layout) EditLeaf(address string, editFunc func(tea.Model) (tea.Model, error)) error
  • func (b *Layout) Init() tea.Cmd
  • func (b *Layout) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (b *Layout) UpdateSize(size tea.WindowSizeMsg) error
  • func (b *Layout) View() string
• type Node
  • func NewNode(o Orientation, withBorder bool) *Node
  • func (n *Node) AddChild(child Node)
  • func (n *Node) GetAddress() string
  • func (n *Node) GetHeight() int
  • func (n *Node) GetWidth() int
  • func (n *Node) IsLeaf() bool
  • func (n *Node) SetSizeFunc(sf SizeFunc)
• type NotFoundError
• type Orientation
• type SizeError
• type SizeFunc

Constants

const (
	// NEWLINE is used to separat the lines
	NEWLINE = "\n"
	// SPACE is used to fill up the lines, make sure it is only one column wide and a single character
	SPACE = " "
	// HorizontalSeparator is used to make a visible border between the horizontal arranged children
	// in the layout-tree, make sure it is only one column wide and a single character
	HorizontalSeparator = "│"
	// VerticalSeparator is used to make a visible border between the vertical arranged children
	// in the layout-tree, make sure it is only one column wide and a single character
	VerticalSeparator = "─"
)

Types

type Layout

type Layout struct {
	// contains filtered or unexported fields
}

Layout is a way to render multiple `tea.Model“s in a specific layout. The models are kept separate from the layout tree so that changing a Model does not require traversing the tree.

func NewLayout

func NewLayout(root Node, logger *slog.Logger) *Layout

New returns a new Layout.

func (*Layout) AddLeaf

func (b *Layout) AddLeaf(address string, model tea.Model) (Node, error)

AddLeaf adds a new leaf node to the tree.

func (*Layout) EditLeaf

func (b *Layout) EditLeaf(address string, editFunc func(tea.Model) (tea.Model, error)) error

EditLeaf is a saver way to interact with the Leafs, since it can not be forgotten to save back the Model after changing. If the editFunc returns an error the Model is not saved.

func (*Layout) Init

func (b *Layout) Init() tea.Cmd

Init satisfies the tea.Model interface

func (*Layout) Update

func (b *Layout) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update handles WindowSizeMsg and ctrl+c

func (*Layout) UpdateSize

func (b *Layout) UpdateSize(size tea.WindowSizeMsg) error

UpdateSize set the width and height of all Node's

func (*Layout) View

func (b *Layout) View() string

View renders the contained tea.Model's according to the LayoutTree

type Node

type Node struct {
	// contains filtered or unexported fields
}

Node is a node in a layout tree.

func NewNode

func NewNode(o Orientation, withBorder bool) *Node

NewNode returns a new Node.

func (*Node) AddChild

func (n *Node) AddChild(child Node)

AddChild adds a new child to this node.

func (*Node) GetAddress

func (n *Node) GetAddress() string

GetAddress returns the Address of the Node The address of a Node is only settable through CreateLeaf

func (*Node) GetHeight

func (n *Node) GetHeight() int

GetHeight returns the current with of this node

func (*Node) GetWidth

func (n *Node) GetWidth() int

GetWidth returns the current with of this node

func (*Node) IsLeaf

func (n *Node) IsLeaf() bool

IsLeaf returns if the node is a leaf.

func (*Node) SetSizeFunc

func (n *Node) SetSizeFunc(sf SizeFunc)

SetSizeFunc sets the function that defines the dynamic width or height of children nodes.

type NotFoundError

type NotFoundError error

NotFoundError convey that the address was not found.

type Orientation

type Orientation uint8

Orientation specifies the rendering orientation.

const (
	Horizontal Orientation = iota + 1
	Vertical
)

type SizeError

type SizeError error

SizeError conveys that for at leased one node or leaf in the Layout-tree there was not enough space left

type SizeFunc

type SizeFunc func(n Node, widthOrHeight int) []int

SizeFunc is the function that defines the dynamic width or height of nodes.