ZigTUI

Zig 跨平台 TUI 库，灵感来自 Ratatui。

功能

• 跨平台 — Windows、Linux、macOS
• 高效渲染 — 基于单元的差异对比，只重绘变化部分
• 组件 — 块、段落、列表、仪表、表格
• 15种内置主题 — Nord、Dracula、Gruvbox、Catppuccin、Tokyo Night...
• Kitty图形协议 — 显示图片（支持Unicode回退）
• 无隐藏分配 — 显式内存管理

要求

• Zig 0.15.0及以上
• Windows 10及以上 / Linux / macOS

安装

zig fetch --save git+https://github.com/adxdits/zigtui.git

// build.zig
const zigtui = b.dependency("zigtui", .{ .target = target, .optimize = optimize });
const exe = b.addExecutable(.{
    .name = "myapp",
    .root_module = b.createModule(.{
        .root_source_file = b.path("src/main.zig"),
        .target = target,
        .optimize = optimize,
        .imports = &.{
            .{ .name = "zigtui", .module = zigtui.module("zigtui") },
        },
    }),
});

git submodule add https://github.com/adxdits/zigtui.git libs/zigtui

const zigtui_module = b.addModule("zigtui", .{
    .root_source_file = b.path("libs/zigtui/src/lib.zig"),
});

快速开始

const std = @import("std");
const tui = @import("zigtui");
pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const allocator = gpa.allocator();
    var backend = try tui.backend.init(allocator);
    defer backend.deinit();
    var terminal = try tui.terminal.Terminal.init(allocator, backend.interface());
    defer terminal.deinit();
    try terminal.hideCursor();
    defer terminal.showCursor() catch {};
    var running = true;
    while (running) {
        const event = try backend.interface().pollEvent(100);
        if (event == .key) {
            if (event.key.code == .esc or (event.key.code == .char and event.key.code.char == 'q'))
                running = false;
        }
        try terminal.draw({}, struct {
            fn render(_: void, buf: *tui.render.Buffer) !void {
                tui.widgets.Block{
                    .title = "Hello ZigTUI — press 'q' to quit",
                    .borders = tui.widgets.Borders.all(),
                    .border_style = .{ .fg = .cyan },
                }.render(buf.getArea(), buf);
            }
        }.render);
    }
}

小部件

// Block — container with border/title
tui.widgets.Block{ .title = "Panel", .borders = tui.widgets.Borders.all() }
// Paragraph — text display
tui.widgets.Paragraph{ .text = "Hello!", .wrap = true }
// List — scrollable items
tui.widgets.List{ .items = &items, .selected = 0, .highlight_style = .{ .bg = .blue } }
// Gauge — progress bar
tui.widgets.Gauge{ .ratio = 0.75, .label = "75%" }
// Table — tabular data
tui.widgets.Table{ .header = &columns, .rows = &rows }

Themes

const theme = tui.themes.catppuccin_mocha;
tui.widgets.Block{
    .title = "Dashboard",
    .style = theme.baseStyle(),
    .border_style = theme.borderFocusedStyle(),
};

可用主题： default，nord，dracula，monokai，gruvbox_dark，gruvbox_light，solarized_dark，solarized_light，tokyo_night，catppuccin_mocha，catppuccin_latte，one_dark，cyberpunk，matrix，high_contrast

运行 zig build run-themes 以预览所有主题。

示例

zig build run-dashboard   # System monitor demo
zig build run-kitty       # Image display demo  
zig build run-themes      # Theme showcase

Kitty 图形

在支持 Kitty 图形协议 的终端中显示图像。自动回退到 Unicode 块。

var gfx = tui.Graphics.init(allocator);
defer gfx.deinit();
var bmp = try tui.graphics.bmp.loadFile(allocator, "image.bmp");
const image = tui.Image{ .data = bmp.data, .width = bmp.width, .height = bmp.height, .format = .rgba };
if (gfx.supportsImages()) {
    if (try gfx.drawImage(image, .{ .x = 0, .y = 0 })) |seq| try backend.write(seq);
} else {
    gfx.renderImageToBuffer(image, buffer, area); // Unicode fallback
}

支持： Kitty、WezTerm、foot、Konsole（部分支持） 备用： Windows Terminal、iTerm2、Terminal.app

平台支持

| 平台 | 终端 | 说明 | |----------|----------|-------| | Windows 10及以上 | Windows Terminal、WezTerm | 原生控制台API | | Linux | 任何兼容ANSI的终端 | POSIX termios | | macOS | Kitty、WezTerm、Terminal.app | POSIX termios |

许可证

MIT

贡献

欢迎提交问题和拉取请求。

--- Tranlated By Open Ai Tx | Last indexed: 2026-02-06 ---