v0.25.0

Major mouse improvements, better input parsing, and lots more!

We hope you’re ready for winter. Unless you’re in the southern hemisphere (like @caarlos0) in which case, we hope you’re ready for summer. In either case, we hope you have a happy new year if the Julian calendar is something you’re into.

There are a bunch of good features in this release and a ton of input-related improvements. Read on for more!

Extended Mouse Mode

Bubble Tea now supports Extended Mouse Mode (aka SGR mode) which makes now mouse support in Bubble Tea way, way better.

Prior to this release Bubble Tea used the X10 mouse protocol. X10 was last released in 1986: a time when screen resolutions were smaller, memory limits were low, and a terminal sizes were tiny. For terminals and mice this meant that the mouse tracking stopped after the 127th horizontal cell. Well, thanks to the elite abilities of @aymanbagabas Bubble Tea can now track mouse movements across the entire terminal window, no matter how enormous.

And that's not all: Bubble Tea now has higher fidelity access to mouse operations such as shift, ctrl, and alt modifiers, mouse button release events, and a big range of mouse button and mouse wheel events.

For details see the docs for the new and improved MouseEvent.

Setting the Window Title

@aymanbagabas also wanted to be able to set the terminal window title with Bubble Tea, so he added the SetWindowTitle Cmd. Now setting the window title is as simple as:

func (m Model) Update(msg tea.Msg) (tea.Model. tea.Cmd) {
    return m, tea.SetWindowTitle("oh my")
}

FPS Control

Have you ever thought “Bubble Tea is too fast and I just can’t handle it?” Or perhaps 60fps is too slow and you want to go full 120fps. Now, thanks to @tomfeigin’s WithFPS ProgramOption you can:

// Let’s go with the classic soap opera frame rate
p := tea.NewProgram(model, tea.WithMaxFPS(45))

Better Input, Better Living

@knz is just incredible. He took a look at Bubble Tea’s input parser and whipped it into shape with what felt like a flick of the wrist. Keyboard input is now more efficient than ever and very large amounts of input can be parsed with the greatest of ease. It's hard to overstate how impactful his contributions are—and there are more in the pipe.

Changelog

New!

• Extended Coordinates mouse reporting and additional button support by @aymanbagabas in #594
• Option to set max FPS by @tomfeigin in #578
• SetWindowTitle command by @aymanbagabas in #611

Fixed

• Invert the key parsing control loop by @knz in #569
• Simplify the key input analysis code by @knz in #568
• Support very long buffered input in key parsing by @knz in #570
• Make ReleaseTerminal/RestoreTerminal thread safe by @caarlos0 in #791

Full Changelog: v0.24.2...v0.25.0

New Contributors

• @tomfeigin made their first contribution in #578
• @bloznelis made their first contribution in #763
• @grafviktor made their first contribution in #770
• @naglis made their first contribution in #787
• @grrlopes made their first contribution in #804
• @Juneezee made their first contribution in #812
• @ddworken made their first contribution in #828
• @wI2L made their first contribution in #829
• @guyfedwards made their first contribution in #865

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.24.2

This point release fixes a race condition that could occur when stopping the default renderer:

• fix: stop renderer before acquiring mutex by @muesli in #757

Full Changelog: v0.24.1...v0.24.2

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.24.1

You can pipe again

This point release fixes a regression introduced in v0.24.0 in which keyboard and mouse input would be lost when piping and redirecting into a program with default inputs. Special thanks to @pomdtr for…piping up about the regression.

• fix: auto-open a TTY when stdin is not a TTY (regression) by @meowgorithm in #746

Full Changelog: v0.24.0...v0.24.1

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.24.0

It is finally time for another Bubble Tea release!

This release contains 31 commits by 14 contributors. Thank you everyone! 💕

Without further ado, here's a list of the most important changes:

Message handling and filtering

The tea.QuitMsg is now exported and you can use tea.WithFilter to filter which messages your model will receive:

func filter(m tea.Model, msg tea.Msg) tea.Msg {
  if _, ok := msg.(tea.QuitMsg); !ok {
      return msg
  }

  model := m.(myModel)
  if model.hasChanges {
      return nil
  }

  return msg
}

p := tea.NewProgram(Model{}, tea.WithFilter(filter));

if _,err := p.Run(); err != nil {
  fmt.Println("Error running program:", err)
  os.Exit(1)
}

Testing

We are introducing an our very own /x package, which contains the teatest package.

With teatest, you can easily run a tea.Program, assert its final model and/or output.

This package required a couple of new methods on Bubble Tea, namely Program.Wait(), WithoutSignals.

You can see an example usage in the simple example.

Bug fixing

We try hard to not let any of them pass, but we know, sometimes a few of them do. This release also gets rid of a bunch of them.

What's Changed

• feat: LogToFileWith by @caarlos0 in #692
• feat: add generic event filter by @muesli in #536
• feat(deps): bump golang.org/x/text from 0.3.7 to 0.3.8 by @dependabot in #674
• feat(ci): auto go mod tidy examples by @caarlos0 in #561
• feat: tea.Wait by @caarlos0 in #722
• feat: allow to disable signals by @caarlos0 in #721
• fix: Check if program cancelReader is is nil before invoking by @nderjung in #643
• fix: renderer only stops once by @muesli in #685
• fix: stop renderer before launching a child process. by @muesli in #686
• fix(output): reuse termenv output by @aymanbagabas in #715
• chore: make input options mutually exclusive by @meowgorithm in #734
• chore: bump console dep by @muesli in #700
• chore(deps): bump actions/setup-go from 3 to 4 by @dependabot in #701
• chore: bump termenv, lipgloss, x/term by @muesli in #711
• docs: using the x/exp/teatest package by @caarlos0 in #352
• docs: fix portal markdown URL syntax by @mjmammoth in #669
• docs: fix typos and clean up comments by @gzipChrist in #672
• docs: countdown to Bubble Tea in the Wild by @aldernero in #679
• docs: issue template by @caarlos0 in #389
• docs: update issue templates by @bashbunni in #712
• docs: remove british spelling by @bashbunni in #719
• docs: add WG Commander to README.md by @AndrianBdn in #667
• docs: filepicker Example by @maaslalani in #683
• docs(README): add eks-node-viewer to "Bubble Tea in the Wild" list by @Nezz7 in #619

New Contributors

• @mjmammoth made their first contribution in #669
• @gzipChrist made their first contribution in #672
• @Nezz7 made their first contribution in #619
• @AndrianBdn made their first contribution in #667
• @aldernero made their first contribution in #679

Full Changelog: v0.23.2...v0.24.0

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.23.2

Hello Bugfixes

This is a small maintenance release with two small but acute fixes from our wonderful community. Thanks for the support! 💘

Fixed

• Ensure Msg Cmd is not nil before invoking (to avoid a nil pointer exception) by @nderjung in #640
• Add support for BatchMsg to Sequence by @stoffeastrom in #581

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.23.1

This bugfix release addresses an issue that was introduced by v0.23.0 and prevented programs from re-using stdin after a tea.Program had finished execution.

---

Changelog

Fixed!

• Don't close stdin by @muesli in #598

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.23.0

If you are closely following Bubble Tea's development, you may have already noticed that we have been really busy fixing a lot of issues and merged more than just a couple of feature requests in recent weeks. This v0.23.0 release is in fact our biggest update since the initial release of the package: in the last 3 months over 100 commits have reached us by more than 30 individual contributors! Thank you everyone! 💕

Here's a quick overview of what has changed:

Custom Outputs

Don't want to render your beautiful TUI to stdout? A buffer or an alternative file descriptor like stderr seems more
appropriate? We got you covered now:

Render to stderr

p := tea.NewProgram(model, tea.WithOutput(os.Stderr))

Render to a Buffer

var buf bytes.Buffer
p := tea.NewProgram(model, tea.WithOutput(&buf))

Run Like the Wind

We've introduced the aptly named method Program.Run which replaces and deprecates the existing Program.Start and
Program.StartReturningModel methods. This unifies and clarifies the blocking behavior of the Bubble Tea program execution.

The old methods will continue to work for now, but please update your programs accordingly:

p := tea.NewProgram(model, tea.WithOutput(os.Stderr))
model, err := p.Run() // instead of p.Start or p.StartReturningModel
...

Bug Fix Galore!

The initialization and tear-down methods of tea.Program have been revised and some long-standing problems have been resolved. We couldn't list every single fix in the release notes, so please check out the full changelog below!

🤗 Thanks

We would like to particularly thank @knz who is the sole author of more than a dozen PRs since the last release. Outstanding work!

---

Changelog

New

• Render to custom outputs, io.Writers and buffers (tea.WithOutput)
• Support for new keys: Ctrl(+Alt) - Page, Home, End, and Insert keys
• Signal handler is optional with program option tea.WithoutSignalHandler
• tea.ClearScreen, tea.ShowCursor commands
• Exported BatchMsg

Fixed!

• Race conditions in console renderer
• Issues restoring terminal state on shutdown
• Kill not resulting in an error returned by Program.Run
• Repaint behavior
• Skip over unrecognized CSI sequences
• Function keys on urxvt
• Function keys on Linux console
• Rendering issues with overflowing output buffers
• Ensure final render on clean shutdown
• Cursor visibility on altscreen state switch
• Deadlock in Program.Send on shutdown

Deprecated

• Program.Start, Program.StartReturningModel: please use Program.Run

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Discord.

v0.22.1

Mutli-Byte Character Support on Windows

This is a small release with a big impact for Chinese, Japanese, and Korean users on Windows. The long as short of it is that if you’re using a multi-byte character set that’s not UTF-8, Bubble Tea will covert stuff for you so things work as expected. For details see #343.

🤗 Enormous thanks to @mattn for the contribution as well as his Go libraries that make CJK support in the Charm ecosystem possible.

👾 Also, thanks to @aklyachkin, if Bubble Tea on AIX is something you want your dream is a now a reality.

Changelog

• support multi-byte strings on Windows by @mattn in #343
• enable compilation on AIX by @aklyachkin in #381

Full Changelog: v0.22.0...v0.22.1

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Slack.

v0.22.0

Unmanaged Output

Now you can print unmanaged output above your inline applications. This means you can print stuff above your app that won't be cleared on the next render. It’s super useful for cases where you want to build an apt-like package manager.

Let’s Print

This release introduces two new Cmds that print output above your inline Bubble Tea program:

tea.Println("Hello, Bubble Tea")
tea.Printf("%s, %s", "Hello", "Bubble Tea")

Use it anytime you want to add log-type info to the terminal’s scrollback buffer, such as building your own package manager 📦. And keep in mind that these methods are no-op’s in altscreen mode.

For details see the full example and the docs.

🤗 Thanks

@fiws has been bugging us to implement this forever and then @Adjective-Object swooped in and did it with style and grace! It’s been a great collaboration all around.

---

Changelog

New

• Credit card input form example by @maaslalani in #338
• Allow unmanaged output above the app in standard renderer by @Adjective-Object in #249

Fixed!

• Race condition on repaint by @georgijd in #330
• Handle batched key msgs by @muesli in #326

New Contributors

• @georgijd made their first contribution in #330
• @joaom00 made their first contribution in #313
• @maaslalani made their first contribution in #338
• @Adjective-Object made their first contribution in #249

Full Changelog: v0.21.0...v0.22.0

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Slack.

v0.21.0

Spawn Interactive Processes + More Keybindings

Finally! This update allows you to run blocking, interactive processes from Bubble Tea like vim, htop, curl, and even entire shells like fish. It also adds a bunch of new keybindings. Read on for more!

Let’s Exec

As we were saying, you can now spawn interactive processes in the terminal from Bubble Tea and resume Bubble Tea when they exit. For example, you could have your Bubble Tea program spawn vim to edit a file, or temporarily open a shell, like fish. Here’s what it looks like:

type editorFinishedMsg struct{ err error }

func openInVim(path string) tea.Cmd {
	c := exec.Command("vim", path)
	return tea.ExecProcess(c, func(err error) tea.Msg {
		return editorFinishedMsg{err}
	})
}

See the full example for details.

Keys Galore

Prior to this update, you couldn't bind to the functions keys. Isn't that crazy? @mrusme certainly thought so. With this update you can can now respond to F1 through F20, modifiers included.

And thanks to @Bwahharharrr you can also now bind to arrow keys with the ctrl, shift and alt modifiers.

---

High-Level Changelog

New

• move cancelreader into a separate package by @muesli in #222
• Exec, program.ReleaseTerminal and RestoreTerminal to re-use input and terminal by @muesli in #237
• add support for shift/ctrl + arrow keys by @meowgorithm in #292
• add function key support by @meowgorithm in #263

Changed

• spacebar now sends a KeySpace by @bashbunni in #289 and #315
• Program#Send, Program#Quit, and Program#Kill no longer provisional by @meowgorithm in #271

New Contributors

• @r-darwish made their first contribution in #225
• @wolves made their first contribution in #250
• @imranZERO made their first contribution in #254
• @iamjaredwalters made their first contribution in #279
• @bashbunni made their first contribution in #289

Full Changelog: v0.20.0...v0.21.0

---

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or Slack.