Adding a router bubble for navigation

[KaviiSuri]

This PR Adds a router bubble to make developing multi-screen bubbletea apps easier.

This is just a prototype!

[KaviiSuri]

@maaslalani I've developed a rough prototype for a router bubble (Closes #179). Still needs a lot of improvements like:

• Stack based routing (basically keeping track of back and using it)
• Help text
• Better helper methods and design

Would love to discuss this with you! (maybe over discord?)

[maaslalani]

Yes, let's definitely discuss this over discord! Thank you so much for this initiative, it will change the way we build multi-screen TUIs and set much better standards into place. I have a bit of feedback and a few ideas on how we can make this super solid!

[maaslalani]

I wonder if we should Init all the screens here?

[KaviiSuri]

Yeah, makes sense, will do!

[KaviiSuri]

@maaslalani I was wondering if I should only init the current screen or all of them.

Because in case we do all of them, how do we handle the return messages?

[maaslalani]

I believe you're right, It probably makes sense to Init the current screen, we should probably keep track of whether the screen has been initialized and do that on first load (we should check this every time the navigator switches screens).

[KaviiSuri]

Makes sense, so it'll be kind of lazily executed Init. If there's a need for something to be executed right away in the future, we can extend the api to accomodate

[KaviiSuri]

@maaslalani done with the initialisation logic, how do you recommend handling invalid m.current

[KaviiSuri]

@maaslalani are there any changes or should I start working on documentation for the bubble?

[maaslalani]

Hey @KaviiSuri, I will need to give this more thought to make sure it can fit all use cases we have for navigation. But, this is an awesome start. Thank you so much for this contribution.

[maaslalani]

One thing I did think of is we probably will want to make the screens a map[string]tea.Model / map[string]Screen so that each screen has an associated id such that you can navigate to screens / models directly using some helper function.

const (
  homeScreen = "home"
  settingsScreen = "settings"
)

// Somewhere else in the application...
navigator.Navigate(homeScreen)
navigator.Push(settingsScreen)

[KaviiSuri]

@maaslalani Yupp, makes sense, will come up with something soon.

[KaviiSuri]

@maaslalani I've added a history stack to thr router.

P.S. Sorry for the delay, had some stuff going on

[maaslalani]

Hey @KaviiSuri, thanks again for this PR. I'm going to schedule a bit of time later on to play with this and then we can get this merged in to the experimental package:

• https://github.com/charmbracelet/x

So that others can play with it and try it out themselves so we can get some feedback before making it official.