Shirei - Cross platform GUI framework

What Shirei code looks like

Build the current interface with functions, structs, loops, and ordinary control flow.

Mutable data goes straight into controls

type Profile struct {
    Name  string
    Email string
    Saved bool
}

func ProfileForm(profile *Profile) {
    Container(Attrs(Expand, Pad(18), Gap(8)), func() {
        Label("Profile", FontSize(22),
            FontWeight(WeightBold))

        Label("Name")
        TextInput(&profile.Name)

        Label("Email")
        TextInput(&profile.Email)

        Container(Attrs(Row, CrossMid, Gap(10)), func() {
            if Button(SymITick, "Save") {
                profile.Saved = true
            }
            if profile.Saved {
                Label("All changes saved",
                    FontSize(12),
                    TextColor(145, 55, 34, 1))
            }
        })
    })
}

A Go loop is UI composition

func ArticleCard(article *Article) {
    Container(Attrs(Expand, Pad(18), Gap(10)), func() {
        Label(article.Title,
            FontSize(20),
            FontWeight(WeightBold))
        Label(article.Summary)

        Container(Attrs(Row, Wrap, Gap(7)), func() {
            for _, tag := range article.Tags {
                Tag(tag)
            }
        })
    })
}

func Tag(label string) {
    Container(Attrs(Pad2(5, 10), Corners(14),
        Background(220, 32, 90, 1)), func() {
        Label(label, FontSize(12))
    })
}

Rendered article card with a title, summary, and tag pills

An if statement controls what exists

type Contact struct {
    Name      string
    Email     string
    ShowEmail bool
}

func ContactCard(contact *Contact) {
    Container(Attrs(Expand, Pad(18), Gap(10)), func() {
        Label(contact.Name,
            FontSize(20),
            FontWeight(WeightBold))

        if Button(NoIcon, "Show email") {
            contact.ShowEmail = !contact.ShowEmail
        }

        if contact.ShowEmail {
            Container(Attrs(Expand, Pad(10), Corners(6),
                Background(145, 25, 92, 1)), func() {
                Label(contact.Email)
            })
        }
    })
}

Rendered contact card with a button and conditionally visible email address

Latest release

» Shirei v0.6.6 — Release packaging

Getting Started

Import package name: go.hasen.dev/shirei

Github repo: https://github.com/hasenj/go-shirei

Copy the code sample above to a new file in an empty directory, then run the following to download the dependencies:

❯ go mod init main
❯ go mod tidy
❯ go run .

You can browse the demo directories on the github repo for more examples.

Read the Tutorial →

Core Features

Native. Real computer program (binary executable): not a "web page".
Cross platform. macOS/Windows/Linux(Wayland/X11)/iOS/Android.
No boilerplate setup. Start writing application code right away.
Plain-data UI. Build the current interface using ordinary Go values, loops, and conditionals. No need to create and synchronize application-owned widget objects.
Integrated framework. Shirei owns the window and update lifecycle. Controls, robust text editing, virtual lists and tables, modal and focus helpers, software rendering, and headless snapshots work with the same layout and input machinery.
Flexbox-like layout. Containers arrange items horizontally or vertically, with options for padding, gaps, alignment, wrapping, floating, scrolling, and size expansion.
Robust text support. Bidirectional layout, shaping, IME, system fonts, inline text styling.
Audio output. Low-level sample streams that work on all platforms.
Platform layer access. Extension packages can support platform features that are not included in Shirei itself.
Deterministic full-interface testing. Render the normal application frame to an image without opening a native window or requiring a GPU.
Ordinary Go background work. Publish state from goroutines and request an update when new data is ready.
Release packaging. shirei_bundle produces signed iOS IPAs, release Android APKs, macOS app/zip/pkg packages, and Linux and Windows archives.shirei_mobilerun provides fast development installs on phones and simulators.

For the full picture — the application model, layout mechanics, colors and text styling, interaction, application patterns, and a reference section of common mistakes — see the full tutorial.

Examples

The following example programs ship with Shirei and are useful programs in their own right.

Each card links to that example's directory on GitHub, with a README and the full source. They live under examples/ in the go-shirei repo and run with go run ./examples/<name> after cloning.

Cross-platform Declarative GUI framework for Go

Native Go

Declarative UI

Flexbox-style layout

What Shirei code looks like

A complete, runnable demo

Explore more live demos

Interactive demos

Custom widgets

Latest release

Getting Started

Core Features

Examples

git_history

haystack

process_monitor

dir_weight

piano

fontviewer

icons

see_pprof

see_exe

hacker-news-reader