reactea
Rather simple Bubbletea companion for handling hierarchy and support for lifting state up. It Reactifies Bubbletea philosophy and makes it especially easy to work with in bigger projects.
For me, personally – It’s a must in project with multiple pages and component communication
Check our example code right here!
Installation
go get -u github.com/londek/reactea
Example code
There is no tutorial yet so I suggest checking our example!
General info
The goal is to create components which are
- dimensions-aware (especially unify all setSize conventions)
- propful
- easy to lift the state up
- able to communicate with parent without importing it (I spent too many hours solving import cycles hehe)
- easier to code
- all of that without code duplication
The extreme performance is not main goal of this package, because either way Bubbletea refresh rate is only 60hz and 50 allocations in entire runtime won’t really hurt anyone. Most info is currently in source code so I suggest checking it out
Always return reactea.Destroy instead of tea.Quit in order to follow our convention\
As of now Go doesn’t support type aliases for generics, so Renderer[TProps] has to be explicitely casted. It’s planned for Go 1.20
Component lifecycle
reactea takes pointer approach for components making state modifiable in any lifecycle method There are also 2 additional lifecycle methods: AfterUpdate() and UpdateProps()
AfterUpdate()
AfterUpdate() is the only lifecycle method that is not controlled by parent. It’s called right after root component finishes Update(). Components should queue itself with reactea.AfterUpdate(component) in Update()
UpdateProps()
UpdateProps() is a lifecycle method that derives state from props, It can happen anytime during lifecycle. Usually called by Init()
Notes
Update() IS NOT guaranteed to be called on first-run, Init() for most part is, and critical logic should be there
Lifecycle is (almost, see AfterUpdate()) fully controlled by parent component making graph above fully theoretical and possibly invalid for third-party components
Stateless components
Stateless components are represented by following function types
| Renderer[TProps any] | ProplessRenderer | DumbRenderer | |
|---|---|---|---|
| Properties | ✅ | ❌ | ❌ |
| Dimensions | ✅ | ✅ | ❌ |
| Arguments | TProps, int, int |
int, int |
❌ |
There are many utility functions for transforming stateless into stateful components or for rendering any component without knowing its type (reactea.RenderAny)
Reactea Routes API
Routes API allows developers for easy development of multi-page apps. They are kind of substitute for window.Location inside bubbletea
reactea.CurrentRoute() Route
Returns current route
reactea.LastRoute() Route
Returns last route
reactea.WasRouteChanged() bool
returns LastRoute() != CurrentRoute()
Router Component
Router Component is basic implementation of how routing could look in your application. It doesn’t support wildcards yet or relative pathing. All data is provided from within props
router.Props
router.Props is a map of route initializers keyed by routes
What is RouteInitializer?
RouteInitializer is function that initializes the current route component
