bubbles

package module
v0.10.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2022 License: MIT Imports: 0 Imported by: 0

README

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.

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.

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

  • 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.
  • mritd/bubbles: Some general-purpose bubbles. Inputs with validation, menu selection, a modified progressbar, and so on.

If you’ve built a Bubble you think should be listed here, let us know.

License

MIT


Part of Charm.

The Charm logo

Charm热爱开源 • Charm loves open source

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package key provides some types and functions for generating user-definable keymappings useful in Bubble Tea components.
Package key provides some types and functions for generating user-definable keymappings useful in Bubble Tea components.
Package list provides a feature-rich Bubble Tea component for browsing a general purpose list of items.
Package list provides a feature-rich Bubble Tea component for browsing a general purpose list of items.
Package paginator provides a Bubble Tea package for calulating pagination and rendering pagination info.
Package paginator provides a Bubble Tea package for calulating pagination and rendering pagination info.
Package stopwatch provides a simple stopwatch component.
Package stopwatch provides a simple stopwatch component.
Package timer provides a simple timeout component.
Package timer provides a simple timeout component.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL