gpuikit 0.9.0

A UI toolkit for GPUI applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# gpuikit

[![crates.io](https://img.shields.io/crates/v/gpuikit.svg)](https://crates.io/crates/gpuikit)
[![docs.rs](https://docs.rs/gpuikit/badge.svg)](https://docs.rs/gpuikit)
[![CI](https://github.com/iamnbutler/gpuikit/actions/workflows/ci.yml/badge.svg)](https://github.com/iamnbutler/gpuikit/actions/workflows/ci.yml)

> 🚧 Pre-1.0: expect breaking changes in every release. Pin your version. 🚧

A UI toolkit for [gpui](https://www.gpui.rs) applications. Targeting a conceptual union of SwiftUI and web-style component libraries to make building modern gpui applications seamless.

[See it in action →](https://nate.rip/gpuikit/)

![The gpuikit showcase](https://raw.githubusercontent.com/iamnbutler/gpuikit/main/.github/media/showcase.png)

## Getting started

gpuikit builds against
[gpui-unofficial](https://github.com/iamnbutler/gpui-unofficial), a crates.io
distribution of gpui — your app should depend on the same one:

```toml
[dependencies]
gpui = { package = "gpui-unofficial", version = "1.14" }
gpui_platform = { package = "gpui-platform-gpui-unofficial", version = "1.14", features = ["font-kit"] }
gpuikit = "0.9"
```

`gpui_platform` is what builds the windowing platform an `Application` runs on;
gpuikit re-exports neither it nor `gpui`, so your app names all three.

```rust
use gpui::Application;

fn main() {
    Application::with_platform(gpui_platform::current_platform(false))
        .with_assets(gpuikit::assets())
        .run(|cx| {
            gpuikit::init(cx);
            // ... your app
        });
}
```

Browse every component in the [showcase](https://nate.rip/gpuikit/), built
from this repository on every push to `main` — a component can be linked to,
as in [`#table`](https://nate.rip/gpuikit/#table). Offline, the same binary
runs natively:

```sh
cargo run --example showcase --features examples
```

More examples, and how to run them, in [examples/](examples/README.md). API
docs are at [docs.rs/gpuikit](https://docs.rs/gpuikit).

## Feature flags

All off by default:

| Flag              | What it adds                                                                                                 |
| ----------------- | ------------------------------------------------------------------------------------------------------------ |
| `editor`          | The `Editor` component, and syntect-based syntax highlighting for markdown code fences                       |
| `stitch`          | Flicker-free streaming markdown: unterminated syntax (`**bold`) is closed before parsing. Requires Rust 1.95 |
| `runtime_shaders` | Compiles Metal shaders at runtime, so macOS builds don't need the Xcode Metal toolchain                      |
| `schema`          | Adds the `schemars` dependency                                                                               |

## Web

gpuikit runs in the browser on gpui's web platform (WebGPU via wgpu). The
[hosted showcase](https://nate.rip/gpuikit/) is `examples/showcase.rs` built
for `wasm32-unknown-unknown` by [`examples/showcase-web/`](examples/showcase-web),
a [trunk](https://trunkrs.dev) harness. It needs nightly, because gpui's web
platform runs background work on web workers over a shared wasm memory and
std has to be rebuilt with atomics; `scripts/showcase-web.sh` names the
nightly and sets that up:

```sh
scripts/showcase-web.sh serve
```

Then open <http://127.0.0.1:8081> in a WebGPU-capable browser. Nothing in
your own app needs nightly unless it, too, is built for the web.

## Minimum Rust version

1.85, or 1.95 with the `stitch` feature. Some dependencies require newer
stables, so prefer a recent toolchain.

## License

Licensed under either of the [Apache License 2.0](LICENSE-APACHE) or the
[MIT license](LICENSE-MIT), at your option.