gooey

# Gooey

A GPU-accelerated UI framework for Zig. It targets macOS (Metal), Linux (Wayland with
Vulkan or a CPU renderer, or the kernel framebuffer), Windows (Win32 with Vulkan), and the
browser (WASM with WebGPU).

Join the [Gooey discord](https://discord.gg/bmzAZnZJyw)

<img src="https://github.com/duanebester/gooey/blob/main/assets/gooey-logo-final.png"
  height="100px" />

> **0.4.0 replaces the 0.3.1 API:** `gooey.run`, `gooey.core.*`, `cx.animations`, `cx.changed`,
> `cx.accessible`, `cx.io()`, `gooey.file_dialog`, and the validation helpers are gone.
> This readme describes 0.4.0 only.

[![CI](https://github.com/duanebester/gooey/actions/workflows/ci.yml/badge.svg?branch=main)][ci]

[ci]: https://github.com/duanebester/gooey/actions/workflows/ci.yml

Example app built with Gooey 0.2.9: [**chat-zig**](https://github.com/duanebester/chat-zig),
an Anthropic Claude client.

<a href="https://github.com/duanebester/chat-zig">
  <img src="https://github.com/duanebester/gooey/blob/main/assets/screenshots/chat-zig.png"
    height="360px" />
</a>

## Features

- **Small core.** An app is a state struct, a render function, and handlers. `gooey.App`,
  `gooey.Cx`, and `gooey.ui` cover most of it.
- **Static memory.** Each app declares a resource budget at compile time. Gooey reserves
  everything before the first frame, never grows it, and fails fast naming the pool that ran
  out.
- **Flexbox-style layout** with keyed identity, scrolling, popovers, and modals.
- **Text input with IME**, undo, selection, and clipboard through the text engines.
- **Components** (buttons, checkboxes, selects, modals, virtual lists, text inputs, a code
  editor, Lucide icons) and **charts**, built as library code on the public API.
- **Accessibility** through VoiceOver (macOS), UI Automation (Windows), and ARIA (web).
- **Zero dependencies.** No Zig packages; only system frameworks and libraries.

## Requirements

- **Zig 0.17.0** or newer (`minimum_zig_version` in `build.zig.zon`).
- **macOS:** 14.0 or newer.
- **Linux:** a Wayland compositor and Vulkan driver for the default backend, plus FreeType,
  HarfBuzz, Fontconfig, libpng, and D-Bus. See [Linux](#linux).
- **Windows:** 64-bit, with the Vulkan loader your GPU driver installs. No SDK is needed.

## Add Gooey to an application

Fetch the release into your `build.zig.zon`:

```bash
zig fetch --save git+https://github.com/duanebester/gooey#v0.4.1
```

Then import the modules in your `build.zig`. `gooey` is required; `gooey-components` and
`gooey-charts` are optional siblings from the same dependency.

```zig
const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});
    const gooey_dependency = b.dependency("gooey", .{
        .target = target,
        .optimize = optimize,
    });

    const executable = b.addExecutable(.{
        .name = "my-app",
        .root_module = b.createModule(.{
            .root_source