• Stars
    star
    5,325
  • Rank 7,750 (Top 0.2 %)
  • Language
    Go
  • License
    MIT License
  • Created almost 5 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

TUI components for Bubble Tea ๐Ÿซง

Bubbles

The Bubbles Logo

Latest Release GoDoc Build Status Go ReportCard

Some components for Bubble Tea applications. These components are used in production in Glow, Charm and many other applications.

Spinner

Spinner Example

A spinner, useful for indicating that some kind an operation is happening. There are a couple default ones, but you can also pass your own โ€frames.โ€

Text Input

Text Input Example

A text input field, akin to an <input type="text"> in HTML. Supports unicode, pasting, in-place scrolling when the value exceeds the width of the element and the common, and many customization options.

Text Area

Text Area Example

A text area field, akin to an <textarea /> in HTML. Allows for input that spans multiple lines. Supports unicode, pasting, vertical scrolling when the value exceeds the width and height of the element, and many customization options.

Table

Table Example

A component for displaying and navigating tabular data (columns and rows). Supports vertical scrolling and many customization options.

Progress

Progressbar Example

A simple, customizable progress meter, with optional animation via Harmonica. Supports solid and gradient fills. The empty and filled runes can be set to whatever you'd like. The percentage readout is customizable and can also be omitted entirely.

Paginator

Paginator Example

A component for handling pagination logic and optionally drawing pagination UI. Supports "dot-style" pagination (similar to what you might see on iOS) and numeric page numbering, but you could also just use this component for the logic and visualize pagination however you like.

Viewport

Viewport Example

A viewport for vertically scrolling content. Optionally includes standard pager keybindings and mouse wheel support. A high performance mode is available for applications which make use of the alternate screen buffer.

This component is well complemented with Reflow for ANSI-aware indenting and text wrapping.

List

List Example

A customizable, batteries-included component for browsing a set of items. Features pagination, fuzzy filtering, auto-generated help, an activity spinner, and status messages, all of which can be enabled and disabled as needed. Extrapolated from Glow.

File Picker

File picker example

A customizable component for picking a file from the file system. Navigate through directories and select files, optionally limit to certain file extensions.

Timer

A simple, flexible component for counting down. The update frequency and output can be customized as you like.

Timer example

Stopwatch

Stopwatch example

A simple, flexible component for counting up. The update frequency and output can be customized as you see fit.

Help

Help Example

A customizable horizontal mini help view that automatically generates itself from your keybindings. It features single and multi-line modes, which the user can optionally toggle between. It will truncate gracefully if the terminal is too wide for the content.

Key

A non-visual component for managing keybindings. Itโ€™s useful for allowing users to remap keybindings as well as generating help views corresponding to your keybindings.

type KeyMap struct {
    Up key.Binding
    Down key.Binding
}

var DefaultKeyMap = KeyMap{
    Up: key.NewBinding(
        key.WithKeys("k", "up"),        // actual keybindings
        key.WithHelp("โ†‘/k", "move up"), // corresponding help text
    ),
    Down: key.NewBinding(
        key.WithKeys("j", "down"),
        key.WithHelp("โ†“/j", "move down"),
    ),
}

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    switch msg := msg.(type) {
    case tea.KeyMsg:
        switch {
        case key.Matches(msg, DefaultKeyMap.Up):
            // The user pressed up
        case key.Matches(msg, DefaultKeyMap.Down):
            // The user pressed down
        }
    }
    return m, nil
}

Additional Bubbles

  • 76creates/stickers: Responsive flexbox and table components.
  • calyptia/go-bubble-table: An interactive, customizable, scrollable table component.
  • erikgeiser/promptkit: A collection of common prompts for cases like selection, text input, and confirmation. Each prompt comes with sensible defaults, remappable keybindings, any many customization options.
  • evertras/bubble-table: Interactive, customizable, paginated tables.
  • knipferrc/teacup: Various handy bubbles and utilities for building Bubble Tea applications.
  • mritd/bubbles: Some general-purpose bubbles. Inputs with validation, menu selection, a modified progressbar, and so on.
  • treilik/bubbleboxer: Layout multiple bubbles side-by-side in a layout-tree.
  • treilik/bubblelister: An alternate list that is scrollable without pagination and has the ability to contain other bubbles as list items.

If youโ€™ve built a Bubble you think should be listed here, please create a Pull Request. Please note that for a project to be included, it must meet the following requirements:

  • The README has a demo GIF.
  • The README clearly states the purpose of the bubble along with an example on how to use it.
  • The bubble must always be in a working state on its main branch.

Thank you!

Feedback

Weโ€™d love to hear your thoughts on this project. Feel free to drop us a note!

License

MIT


Part of Charm.

The Charm logo

Charm็ƒญ็ˆฑๅผ€ๆบ โ€ข Charm loves open source

More Repositories

1

bubbletea

A powerful little TUI framework ๐Ÿ—
Go
26,561
star
2

gum

A tool for glamorous shell scripts ๐ŸŽ€
Go
17,705
star
3

glow

Render markdown on the CLI, with pizzazz! ๐Ÿ’…๐Ÿป
Go
15,692
star
4

vhs

Your CLI home video recorder ๐Ÿ“ผ
Go
14,678
star
5

lipgloss

Style definitions for nice terminal layouts ๐Ÿ‘„
Go
7,832
star
6

soft-serve

The mighty, self-hostable Git server for the command line๐Ÿฆ
Go
5,174
star
7

huh

Build terminal forms and prompts ๐Ÿคท๐Ÿปโ€โ™€๏ธ
Go
3,994
star
8

wish

Make SSH apps, just like that! ๐Ÿ’ซ
Go
3,428
star
9

freeze

Generate images of code and terminal output ๐Ÿ“ธ
Go
3,091
star
10

mods

AI on the command line
Go
2,830
star
11

pop

Send emails from your terminal ๐Ÿ“ฌ
Go
2,382
star
12

glamour

Stylesheet-based markdown rendering for your CLI apps ๐Ÿ’‡๐Ÿปโ€โ™€๏ธ
Go
2,369
star
13

charm

The Charm Tool and Library ๐ŸŒŸ
Go
2,351
star
14

log

A minimal, colorful Go logging library ๐Ÿชต
Go
2,284
star
15

skate

A personal key value store ๐Ÿ›ผ
Go
1,326
star
16

wishlist

The SSH directory โœจ
Go
1,074
star
17

harmonica

A simple, physics-based animation library ๐ŸŽผ
Go
1,020
star
18

melt

Backup and restore Ed25519 SSH keys with seed words ๐Ÿซ 
Go
579
star
19

kancli

A tutorial for building a command line kanban board in Go
Go
172
star
20

vhs-action

Keep your GIFs up to date with VHS + GitHub actions ๐Ÿ“ฝ๏ธ
TypeScript
163
star
21

bubbletea-app-template

A template repository to create Bubbletea apps.
Go
131
star
22

x

Charm experimental packages
Go
125
star
23

keygen

An SSH key pair generator ๐Ÿ—๏ธ
Go
109
star
24

taskcli

A tutorial for building a Taskwarrior-inspired task tracker in Go using glamorous CLI libraries
Go
97
star
25

inspo

Share and explore projects you can build with Charm libraries
93
star
26

wizard-tutorial

A basic wizard made with Bubble Tea and Lip Gloss. Follow along with the tutorial video for this project:
Go
81
star
27

tree-sitter-vhs

Syntax highlighting for VHS with tree-sitter ๐ŸŒณ
JavaScript
79
star
28

confettysh

confetti over ssh
Go
56
star
29

git-lfs-transfer

Server-side implementation of the Git LFS pure-SSH protocol
Go
50
star
30

catwalk

Open source 3D models from Charm ๐Ÿงธ
50
star
31

soft-serve-action

Synchronize GitHub repositories to your Soft Serve instance ๐Ÿฆ
47
star
32

promwish

Prometheus middleware for Wish
Go
41
star
33

meta

Charm's meta configuration files ๐Ÿซฅ
25
star
34

hotdiva2000

A human-readable random string generator ๐Ÿ‘‘
Go
25
star
35

homebrew-tap

Our homebrew tap ๐Ÿบ
Ruby
23
star
36

scoop-bucket

Charmbracelet Scoop Bucket
15
star
37

nur

Nix
14
star
38

.github

Default community health files
2
star