charmbracelet/lipgloss
Lipgloss
This project is a framework for composing terminal interfaces through declarative styling and a grid-based layout engine. It provides a comprehensive toolkit for building responsive command-line applications by managing ANSI escape sequences, color profiles, and text rendering to ensure consistent visual output across different terminal environments.
The library distinguishes itself through its ability to automatically detect terminal capabilities and background themes, allowing it to adjust color schemes and downsample profiles for optimal readability. It utilizes a layered composition model that supports z-indexing and relative positioning, enabling the construction of complex, nested interfaces from individual styled components.
Beyond core styling, the toolkit includes utilities for rendering structured data such as tables and trees, as well as spatial hit testing for interactive elements. It handles the complexities of terminal display by calculating the visual width of multi-byte characters, managing text wrapping, and providing support for decorative borders and color gradients.
The library is designed for integration into Go-based command-line projects, offering a fluent API for defining immutable style objects and managing terminal output. It includes built-in support for legacy Windows console environments and provides tools for inspecting and debugging visual configurations.
Features
- Terminal User Interfaces - Provides a framework for building visually rich command line interfaces using declarative styling and layout grids.
- Terminal Layout Engines - Implements a grid-based layout engine for composing complex, multi-layered terminal interfaces.
- ANSI Escape Sequence Renderers - Provides a comprehensive engine for managing and rendering ANSI escape sequences to style terminal output.
- Terminal Layout Engines - Arranges text blocks and borders into complex grid structures that adapt to terminal dimensions.
- Terminal Styling - Applies colors, decorations, and formatting to command line output with cross-terminal compatibility.
- Terminal UI Frameworks - Offers a declarative framework for styling and building structured terminal user interfaces.
- Grid Layout Engines - Arranges content using a virtual coordinate system with padding, margins, and alignment controls.
- Declarative Style Objects - Provides a fluent API for defining immutable style objects to manage visual properties declaratively.
- Terminal Output Formatters - Renders formatted text to standard output while automatically adjusting color profiles to terminal capabilities.
- Terminal Color Schemes - Detects terminal background themes and capabilities to adjust foreground colors for optimal readability.
- Data Visualization Components - Renders structured data like tables and trees with custom styles to improve terminal readability.
- String Width Calculators - Calculates the true display width of text by accounting for multi-byte characters and ignoring ANSI sequences.
- Terminal Text Styling - Applies visual formatting and ANSI styles to text while handling multi-byte characters.
- Terminal-Agnostic Renderers - Converts composed grids of terminal cells into final string representations while preserving styles.
- Visual Component Composition Systems - Supports z-indexing and relative positioning to build complex, nested interfaces from individual components.
- Command Line Tools - Layout and styling for terminal interfaces.
- Console Interfaces - Listed in the “Console Interfaces” section of the Awesome Go awesome list.
- Terminal User Interfaces - Declarative styling for terminal layouts and colors.
- Terminal Layout Engines - Manages fixed-size grids for precise placement and manipulation of character cells.
- Terminal Capability Detectors - Queries host environments to detect terminal capabilities and adapt color profiles accordingly.
- Terminal Environment Detection - Detects terminal background themes and capabilities to dynamically adjust color schemes.
- Terminal Environment Detectors - Queries terminal emulators to detect supported features and environment states for adaptive rendering.
- Windows Compatibility Layers - Configures legacy Windows consoles to interpret and render ANSI color sequences correctly.
- Hierarchical Data Structures - Generates formatted tables, nested lists, and hierarchical trees with dynamic formatting based on data depth.
- Adaptive Color Schemes - Automatically selects foreground colors based on detected terminal background brightness.
- Measurement Tools - Calculates visual width and height of rendered text blocks by accounting for multi-cell characters.
- Text Wrapping Utilities - Manages automatic text wrapping within boundaries while preserving ANSI styles and hyperlinks.
- Gradient Generators - Generates one-dimensional or two-dimensional color gradients for text and borders.
- Border Renderers - Constructs decorative frames around text blocks using customizable character sets for visual organization.
- Hit Testing Systems - Identifies visual layers at specific coordinates to enable interactive terminal interfaces and mouse input.
- Text Alignment - Provides utilities for horizontal and vertical text alignment within defined terminal dimensions.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
