A powerful little TUI framework 🏗
Go to file
Christian Rocha 17035473db
More documentation edits
2020-07-29 20:54:15 -04:00
.github/workflows Add Go 1.14 to CI 2020-07-29 17:12:10 -04:00
examples Bump bubbles in examples and remove NewModel function in pager example 2020-07-29 20:07:26 -04:00
tutorials Fix a typo in the basics tutorial 2020-07-23 22:39:54 -04:00
.gitignore Ignore .envrc 2020-04-22 09:53:18 -04:00
LICENSE Add MIT license 2020-01-24 15:07:54 -05:00
README.md Add GoDoc and CI badges 2020-07-29 20:07:26 -04:00
commands.go Remove commands for manually getting terminal size; no longer needed 2020-06-18 22:47:17 -04:00
go.mod Bump bubbles in examples and remove NewModel function in pager example 2020-07-29 20:07:26 -04:00
go.sum Bump bubbles in examples and remove NewModel function in pager example 2020-07-29 20:07:26 -04:00
key.go Don't expose ReadInput 2020-07-29 20:51:55 -04:00
logging.go Improve GoDocs 2020-07-29 20:50:00 -04:00
mouse.go Some comments on mouse stuff 2020-07-13 11:26:57 -04:00
renderer.go Improve GoDocs 2020-07-29 20:50:00 -04:00
screen.go Remove cursor save/restore as it was wrecking things 2020-06-18 20:10:20 -04:00
signals_unix.go Disable resize listening on windows since it's not supported 2020-06-17 12:27:16 -04:00
signals_windows.go Disable resize listening on windows since it's not supported 2020-06-17 12:27:16 -04:00
tea.go More documentation edits 2020-07-29 20:54:15 -04:00
tty_unix.go Rename to Bubble Tea (with the import name tea) 2020-05-25 19:48:36 -04:00
tty_windows.go Rename to Bubble Tea (with the import name tea) 2020-05-25 19:48:36 -04:00

README.md

Bubble Tea

GoDoc Build Status

The fun, functional and stateful way to build terminal apps. A Go framework based on The Elm Architecture.

Bubble Tea is well-suited for simple and complex terminal applications, either inline, full-window, or a mix of both. It's been battle-tested in several large projects and is production-ready.

To get started, see the tutorials and examples.

Bubble Tea in the Wild

For some Bubble Tea programs in production, see:

  • Glow: a markdown reader, browser and online markdown stash
  • The Charm Tool: the Charm user account manager

Libraries we use with Bubble Tea

  • Bubbles various Bubble Tea components we've built
  • Termenv: Advanced ANSI styling for terminal applications
  • Reflow: ANSI-aware methods for reflowing blocks of text
  • go-runewidth: Get the physical width of strings in terms of terminal cells. Many runes, such as East Asian charcters and emojis, are two cells wide, so measuring a layout with len() often won't cut it!

Acknowledgments

Inspired by The Elm Architecture by Evan Czaplicki et al. and go-tea by TJ Holowaychuk.

License

MIT


A Charm project.

the Charm logo

Charm热爱开源!