nuit

Crates.ionuit
lib.rsnuit
version0.2.0
sourcesrc
created_at2023-08-09 00:33:05.157759
updated_at2024-09-06 15:16:29.625925
descriptionDeclarative, cross-platform UI framework for Rust that uses native controls
homepagehttps://github.com/fwcd/nuit
repository
max_upload_size
id939672
size387,319
fwcd (fwcd)

documentation

README

Nuit

Build

A declarative, cross-platform UI framework for Rust that uses native controls.

Crate Description Version Docs
nuit Umbrella crate for the framework crates.io docs.rs
nuit-bridge-adwaita Adwaita backend (Linux, macOS) crates.io docs.rs
nuit-bridge-swiftui SwiftUI backend (macOS, iOS) crates.io docs.rs
nuit-core Core structures and traits crates.io docs.rs
nuit-derive Derive macros crates.io docs.rs

About the Project

The API takes inspiration from contemporary reactive frameworks like SwiftUI, Xilem and React. A central design goal is to avoid using too much macro magic and instead heavily leverage associated types, traits and generics.

A simple hello world program in Nuit takes only a single line:

nuit::run_app(Text::new("Hello world!"));

For a more elaborate example, check out the section below.

[!IMPORTANT] Nuit is still experimental with a rapidly evolving API. As such, treat this library as a sandbox rather than as a finished product, especially if you intend to write an app with it.

While the SwiftUI backend can be considered the reference implementation of the Nuit API, the Adwaita backend is still in early development and does not cover the full API surface yet.

The library also requires a nightly Rust toolchain due to its use of a number of unstable compiler features:

With rustup this can be configured conveniently on a per-directory basis rustup override set nightly or, as in this repository, automatically with a rust-toolchain.toml.

Example

use nuit::{Text, VStack, View, Bind, Button, State};

#[derive(Bind, Default)]
struct CounterView {
    count: State<i32>,
}

impl View for CounterView {
    type Body = impl View;

    fn body(&self) -> Self::Body {
        let count = self.count.clone();
        VStack::new((
            Text::new(format!("Count: {}", count.get())),
            Button::with_text("Increment", move || {
                count.set(count.get() + 1);
            })
        ))
    }
}

fn main() {
    nuit::run_app(CounterView::default());
}

Running this example with

cargo run --example counter

will launch the app with the platform-specific default backend, e.g. SwiftUI on macOS:

Using the Adwaita/GTK4 backend the app looks as follows:

[!TIP] On platforms that support multiple backends (currently only macOS) you can explicitly choose a backend via the NUIT_BACKEND environment variable:

NUIT_BACKEND=adwaita cargo run --example counter
Commit count: 0

cargo fmt