Tuile

A Text User Interface library for Zig.
Breaking changes are possible.
Explore the docs »

View Examples · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Cross-compilation
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

Tuile is a Text User Interface library written in Zig.

Tuile uses crossterm backend by default which works on all UNIX and Windows terminals and supports cross-compilation (powered by build.crab).

See Backends for the list of supported backends, or file a feature request if you want to have another one added.

Checkout the other examples here.

(back to top)

Getting Started

Prerequisites

• Zig 0.12.0+

• Non-default backends may have additional requirements.

Installation

1. Add dependency to your build.zig.zon

zig fetch --save https://github.com/akarpovskii/tuile/archive/refs/tags/v0.1.3.tar.gz

2. Import Tuile in build.zig:

const tuile = b.dependency("tuile", .{});
exe.root_module.addImport("tuile", tuile.module("tuile"));

(back to top)

Usage

const tuile = @import("tuile");

pub fn main() !void {
    var tui = try tuile.Tuile.init(.{});
    defer tui.deinit();

    try tui.add(
        tuile.block(
            .{
                .border = tuile.Border.all(),
                .border_type = .rounded,
                .layout = .{ .flex = 1 },
            },
            tuile.label(.{ .text = "Hello World!" }),
        ),
    );

    try tui.run();
}

You can find more examples in the examples folder

(back to top)

Cross-compilation

To compile an application that uses Tuile for another target, just add -Dtarget=<desired target> when building your app and make sure to forward it to Tuile:

build.zig

const target = b.standardTargetOptions(.{});
const tuile = b.dependency("tuile", .{
  .target = target
});

(back to top)

Roadmap

In no particular order:

• Documentation
• Grid layout
• Windows and dialogs
• Menu bar
• More widgets

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some Amazing Feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

• Best-README-Template

(back to top)