foam

README

foam

Higher-order TUI components for Bubble Tea, composed from Bubbles primitives.

Palette

A command palette with pluggable modes — fuzzy-filter a static list, dispatch an async search, or mix both behind different prefixes.

import "github.com/joelzwarrington/foam/palette"

var commands = []palette.Item{
    palette.Command{Name: "Open file"},
    palette.Command{Name: "Save"},
    palette.Command{Name: "Quit"},
}

mode := palette.Mode{
    Name: "commands",
    Items: func(_ palette.Model, q string) []palette.Item {
        return palette.FilterFuzzy(commands, q)
    },
}

p := palette.New(palette.WithModes(mode))

Each palette.Mode owns its own Match, Items, and optional async Search or typeable Facets. The runnable examples below mix several modes:

• Advanced (↑ demo)
• Simple
• Overlay

Built with

• Bubble Tea — the TUI framework
• Bubbles — the primitive components foam builds on
• Lip Gloss — styling and layout

License

MIT

Documentation

Overview

Package foam provides higher-order TUI components for Bubble Tea, composed from the primitives in charm.land/bubbles/v2.

Each component lives in its own sub-package and follows the standard bubbles contract: a Model with Init, Update, and View, configured via functional options, with public KeyMap and Styles for theming.