How do I customize the spinner animation in Bubbles?

You can pass custom frames to the Spinner component, as shown in the example code for various spinners. This allows you to define your own animation sequences to match your application's style.

Is Bubbles good for building terminal-based file managers?

Yes, the File Picker component is specifically designed for navigating and selecting files, with support for directory traversal and extension filtering. It's production-tested and customizable for such use cases.

Bubbles vs tview for Go TUIs: which should I use?

Bubbles is optimized for the Bubble Tea framework with a component-based, modular approach, while tview is a standalone library with different widgets. Choose Bubbles if you're committed to Bubble Tea for its reactive model and ecosystem.

Can I use Bubbles without Bubble Tea?

No, Bubbles is tightly coupled with Bubble Tea and relies on its event system and model. Attempting to use it standalone would require reimplementing core parts of the framework, making it impractical.

How to handle mouse support in Bubbles components?

Components like Viewport include optional mouse wheel support, as mentioned in the README. You need to enable it in the configuration, but not all components natively support mouse interactions, so check individual documentation.

What's the performance like for large datasets in Bubbles Table?

The Table component supports vertical scrolling and customization, but for very large datasets, you may need to implement virtualization or pagination manually, as performance can degrade with excessive rows rendered at once.

bubbles — TUI Components for Terminal Apps

What is bubbles?

Bubbles is a Go library that provides a collection of production-tested UI components for building terminal user interfaces (TUIs) with the Bubble Tea framework. It offers ready-to-use primitives like input fields, lists, tables, and progress indicators, enabling developers to create rich terminal applications without implementing common interface patterns from scratch. The project emphasizes modularity and customization, allowing components to be tailored while maintaining a cohesive design language.

Target Audience

Go developers building terminal-based applications, such as CLI tools, interactive dashboards, or file managers, who want to leverage pre-built, customizable UI components within the Bubble Tea ecosystem. It is particularly suited for those seeking to avoid reinventing common TUI elements like spinners, text inputs, and lists.

Value Proposition

Developers choose Bubbles because it offers batteries-included, production-ready components that are modular and highly customizable, saving time and effort compared to building TUI primitives from scratch. Its integration with Bubble Tea ensures a consistent design language and seamless development experience for terminal applications.

TUI components for Bubble Tea 🫧

Use Cases

Best For

Building interactive CLI tools with rich user interfaces, such as file pickers or progress indicators.
Creating terminal-based dashboards that require tabular data display with scrolling and navigation.
Developing TUI applications needing multi-line text input areas for chat or story input features.
Implementing paginated lists with fuzzy filtering and auto-generated help in terminal environments.
Adding animated spinners and timers to indicate ongoing operations or countdowns in Go applications.
Managing keybindings and generating help views for user-remappable controls in terminal apps.

Not Ideal For

Projects requiring graphical user interfaces or web-based dashboards
Teams developing applications in languages other than Go, such as Python or Rust
Simple command-line tools that only need basic text output without interactive elements
Environments where dependency on the Bubble Tea framework is undesirable or restrictive

Pros & Cons

Pros

Production-Tested Reliability

Components are used in production applications like Crush and others listed in 'Bubble Tea in the Wild,' ensuring they are battle-tested and reliable for real-world use.

Rich Feature Set

Includes advanced features like fuzzy filtering in lists, Unicode support in text inputs, and customizable spinner frames, as demonstrated in the detailed example GIFs and code snippets.

Modular and Customizable

Emphasizes modularity, allowing components to be tailored or stripped down as needed, such as the List component which can disable pagination or help views, maintaining flexibility.

Comprehensive Examples

Provides extensive example code for each component, like the spinner and text input examples, making it easier for developers to integrate and customize quickly.

Cons

Ecosystem Lock-in

Tightly integrated with the Bubble Tea framework, meaning you cannot use Bubbles components independently, locking you into the Charm ecosystem and its design patterns.

Terminal-Only Limitation

Restricted to terminal-based interfaces with no support for graphical elements, limiting applicability to text-only environments and excluding GUI or web projects.

Breaking Changes Risk

The presence of an upgrade guide for v2 indicates significant API changes, which can introduce migration overhead and compatibility issues for existing projects.

Frequently Asked Questions

What is bubbles?

Target Audience

Value Proposition

Use Cases

Best For

Building interactive CLI tools with rich user interfaces, such as file pickers or progress indicators.
Creating terminal-based dashboards that require tabular data display with scrolling and navigation.
Developing TUI applications needing multi-line text input areas for chat or story input features.
Implementing paginated lists with fuzzy filtering and auto-generated help in terminal environments.
Adding animated spinners and timers to indicate ongoing operations or countdowns in Go applications.
Managing keybindings and generating help views for user-remappable controls in terminal apps.

Not Ideal For

Projects requiring graphical user interfaces or web-based dashboards
Teams developing applications in languages other than Go, such as Python or Rust
Simple command-line tools that only need basic text output without interactive elements
Environments where dependency on the Bubble Tea framework is undesirable or restrictive

Pros & Cons

Pros

Production-Tested Reliability

Components are used in production applications like Crush and others listed in 'Bubble Tea in the Wild,' ensuring they are battle-tested and reliable for real-world use.

Rich Feature Set

Includes advanced features like fuzzy filtering in lists, Unicode support in text inputs, and customizable spinner frames, as demonstrated in the detailed example GIFs and code snippets.

Modular and Customizable

Emphasizes modularity, allowing components to be tailored or stripped down as needed, such as the List component which can disable pagination or help views, maintaining flexibility.

Comprehensive Examples

Provides extensive example code for each component, like the spinner and text input examples, making it easier for developers to integrate and customize quickly.

Cons

Ecosystem Lock-in

Tightly integrated with the Bubble Tea framework, meaning you cannot use Bubbles components independently, locking you into the Charm ecosystem and its design patterns.

Terminal-Only Limitation

Restricted to terminal-based interfaces with no support for graphical elements, limiting applicability to text-only environments and excluding GUI or web projects.

Breaking Changes Risk

The presence of an upgrade guide for v2 indicates significant API changes, which can introduce migration overhead and compatibility issues for existing projects.

Frequently Asked Questions

bubbles

What is bubbles?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

bubbles

What is bubbles?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?