Porting status

This page tracks the porting progress of each Charmbracelet Go package into TUI4J. Status labels used throughout:

Label	Meaning
✅ Done	Fully ported and working identically to the upstream Go example
🟡 In Progress	Under active development; TUI4J logic may still be changing to conform
⚪ TODO	No effort started yet
❌ Won’t do	Not planned, due to technical limitations or an alternative approach taken (see Notes)

Bubble Tea examples

Each entry represents a single Bubble Tea example and the status of its migration to a Java equivalent.

Example	Status	Notes
altscreen-toggle	✅ Done
autocomplete	✅ Done	Uses help, key, and textinput bubbles
cellbuffer	✅ Done	Uses harmonica spring physics
chat	✅ Done	Uses textarea and viewport bubbles
composable-views	✅ Done	Uses timer bubble
credit-card-form	✅ Done	Uses textinput with validation
debounce	✅ Done	Demonstrates rate limiting pattern
exec	✅ Done	Uses terminal suspend/resume for external commands
eyes	✅ Done	Blinking eyes animation
file-picker	✅ Done	Uses filepicker bubble
focus-blur	✅ Done
fullscreen	✅ Done
glamour	✅ Done	Glamour not ported; renders raw markdown in a viewport
help	✅ Done	Uses help and key bubbles
http	✅ Done
list-default	✅ Done
list-fancy	✅ Done
list-simple	✅ Done
mouse	✅ Done
package-manager	✅ Done	Uses progress bubble
pager	✅ Done	Uses viewport bubble
paginator	✅ Done
pipe	✅ Done	Demonstrates piped input handling
prevent-quit	✅ Done	Uses help, key, and textarea bubbles
progress-animated	✅ Done	Uses progress bubble with tick-based animation
progress-download	✅ Done	Uses progress bubble
progress-static	✅ Done	Uses progress bubble
realtime	✅ Done	Uses background thread and `Program.send()` for message injection
result	✅ Done	Demonstrates `Program.runWithFinalModel()`
send-msg	✅ Done	Demonstrates `Program.send()` for external message injection
sequence	✅ Done	Nested sequences and batches not yet supported, needs revisiting
set-window-title	✅ Done
simple	✅ Done	Basic counter example
spinner	✅ Done
spinners	✅ Done	Multiple spinner styles demo
split-editors	✅ Done	Uses textarea bubble
stopwatch	✅ Done	Uses help, key, and stopwatch bubbles
suspend	✅ Done	Uses JLine pause/resume for terminal state management
table	✅ Done	Uses table bubble
table-resize	✅ Done	Uses table bubble with dynamic sizing
tabs	✅ Done	Tab navigation with lipgloss styling
textarea	✅ Done	Standalone textarea demo
textinput	✅ Done
textinputs	✅ Done
timer	✅ Done	Uses timer bubble
tui-daemon-combo	✅ Done	CLI mode switching demo
views	✅ Done	Multi-view navigation demo
window-size	✅ Done

Bubbles

Bubble	Status	Notes
cursor	✅ Done
filepicker	✅ Done	Directory browser with filtering and symlink support
help	✅ Done
key	✅ Done
list	✅ Done
paginator	✅ Done
progress	✅ Done	Spring animation, gradient colors, percentage display
runeutil	✅ Done
spinner	✅ Done
stopwatch	✅ Done	Go-style duration formatting, Elm Architecture compliant
table	✅ Done	Columns, rows, keyboard navigation
textarea	✅ Done	Multi-line editor with cursor movement and word ops
textinput	✅ Done
timer	✅ Done	Countdown timer with start/stop/reset
viewport	✅ Done	Scrollable content with keyboard nav and line wrapping

Lipgloss

What	Status	Notes
Colors and color profiles	✅ Done	ANSI, ANSI256, RGB, HSL, adaptive colors
Borders	✅ Done	Normal, rounded, thick, double, hidden, etc.
Margins and paddings	✅ Done
Width and wrapping	✅ Done	Uses x/ansi for proper grapheme width calculation
Alignment	✅ Done
Max width and max height	✅ Done	Text truncation with ellipsis support
Horizontal and vertical join	✅ Done
Whitespace	✅ Done	Background fill with pattern support
List component	✅ Done
Tree component	✅ Done
Table component	✅ Done

x/ansi

The core x/ansi files and the parser sub-package are partially ported. Several sub-packages (iterm2, kitty, sixel) remain unstarted.

What	Status	Notes
StringWidth	✅ Done	Grapheme-aware string width using ICU4J
Truncate	✅ Done	ANSI-aware truncation with left/right variants
Cut	✅ Done	Extracts visible portion of ANSI-styled text
Strip	✅ Done	Removes all ANSI escape sequences
GraphemeCluster	✅ Done	Proper Unicode grapheme cluster handling
Parser (state machine)	✅ Done	`State`, `Action`, `TransitionTable` for ANSI parsing
Wrap	⚪ TODO	Word wrapping with ANSI awareness
Style (SGR)	⚪ TODO	SGR (Select Graphic Rendition) utilities
Hyperlink	⚪ TODO	OSC 8 hyperlink support
Cursor	⚪ TODO	Cursor movement sequences
Mouse	⚪ TODO	Mouse input parsing and sequences
Clipboard	⚪ TODO	OSC 52 clipboard access
Notification	⚪ TODO	Terminal notifications
Graphics (Sixel)	⚪ TODO	Sixel graphics support
Kitty extensions	⚪ TODO	Kitty terminal protocol extensions
iTerm2 extensions	⚪ TODO	iTerm2 protocol extensions

x/ansi source file detail

x/ansi root files

Go file	Status	Java mapping
`ansi/ansi.go`	⚪ TODO	—
`ansi/ascii.go`	✅ Done	`ansi/Ansi.java`
`ansi/background.go`	⚪ TODO	—
`ansi/c0.go`	✅ Done	`ansi/Ansi.java`
`ansi/c1.go`	✅ Done	`ansi/Ansi.java`
`ansi/charset.go`	⚪ TODO	—
`ansi/clipboard.go`	🟡 In Progress	`ansi/Code.java`
`ansi/color.go`	⚪ TODO	—
`ansi/ctrl.go`	⚪ TODO	—
`ansi/cursor.go`	⚪ TODO	—
`ansi/cwd.go`	⚪ TODO	—
`ansi/doc.go`	⚪ TODO	—
`ansi/finalterm.go`	⚪ TODO	—
`ansi/focus.go`	⚪ TODO	—
`ansi/graphics.go`	⚪ TODO	—
`ansi/hyperlink.go`	⚪ TODO	—
`ansi/inband.go`	⚪ TODO	—
`ansi/iterm2.go`	⚪ TODO	—
`ansi/keypad.go`	⚪ TODO	—
`ansi/kitty.go`	⚪ TODO	—
`ansi/method.go`	✅ Done	`ansi/Method.java`
`ansi/mode.go`	⚪ TODO	—
`ansi/mouse.go`	⚪ TODO	—
`ansi/notification.go`	⚪ TODO	—
`ansi/palette.go`	⚪ TODO	—
`ansi/parser.go`	⚪ TODO	—
`ansi/paste.go`	🟡 In Progress	`ansi/Code.java`
`ansi/reset.go`	⚪ TODO	—
`ansi/screen.go`	⚪ TODO	—
`ansi/sgr.go`	⚪ TODO	—
`ansi/style.go`	⚪ TODO	—
`ansi/title.go`	⚪ TODO	—
`ansi/truncate.go`	✅ Done	`ansi/Truncate.java`, `ansi/Cut.java`
`ansi/width.go`	✅ Done	`ansi/StringWidth.java`, `ansi/GraphemeCluster.java`, `ansi/Strip.java`
`ansi/wrap.go`	⚪ TODO	—

x/ansi/parser sub-package

Go file	Status	Java mapping
`ansi/parser/const.go`	✅ Done	`ansi/parser/State.java`, `ansi/parser/Action.java`
`ansi/parser/seq.go`	✅ Done	`ansi/parser/Action.java`
`ansi/parser/transition_table.go`	✅ Done	`ansi/parser/TransitionTable.java`

x/ansi/iterm2 sub-package

Go file	Status	Java mapping
`ansi/iterm2/file.go`	⚪ TODO	—
`ansi/iterm2/file_test.go`	⚪ TODO	—
`ansi/iterm2/iterm2_test.go`	⚪ TODO	—

x/ansi/kitty sub-package

Go file	Status	Java mapping
`ansi/kitty/decoder.go`	⚪ TODO	—
`ansi/kitty/encoder.go`	⚪ TODO	—
`ansi/kitty/graphics.go`	⚪ TODO	—
`ansi/kitty/options.go`	⚪ TODO	—
`ansi/kitty/writer.go`	⚪ TODO	—

x/ansi/sixel sub-package

Go file	Status	Java mapping
`ansi/sixel/color.go`	⚪ TODO	—
`ansi/sixel/decoder.go`	⚪ TODO	—
`ansi/sixel/encoder.go`	⚪ TODO	—
`ansi/sixel/palette.go`	⚪ TODO	—
`ansi/sixel/raster.go`	⚪ TODO	—
`ansi/sixel/repeat.go`	⚪ TODO	—

Harmonica

What	Status	Notes
Spring	✅ Done	Spring-based physics animation for smooth UI transitions

The harmonica examples (examples/particle, examples/spring/opengl, examples/spring/tui) are not yet ported.

x sub-packages not yet ported

The following charmbracelet/x packages have no Java mapping and no active work planned at this time:

Package	Description	Status
x/cellbuf	Cell buffer for efficient terminal rendering	⚪ TODO
x/colors	Color conversion and manipulation utilities	⚪ TODO
x/editor	Launch external text editor	⚪ TODO
x/conpty	Windows ConPTY integration	⚪ TODO
x/errors	Error helpers (join)	⚪ TODO
x/etag	ETag helpers	⚪ TODO

Do not depend on these packages being available in TUI4J. There is no committed timeline for porting them.

Get Started

Core Concepts

Components

Guides

Compatibility

Porting status

Bubble Tea examples

Bubbles

Lipgloss

x/ansi

x/ansi source file detail

Harmonica

x sub-packages not yet ported

​Bubble Tea examples

​Bubbles

​Lipgloss

​x/ansi

​x/ansi source file detail

​Harmonica

​x sub-packages not yet ported

Bubble Tea examples

Bubbles

Lipgloss

x/ansi

x/ansi source file detail

Harmonica

x sub-packages not yet ported