guido 0.12.0

A reactive Rust GUI library using wgpu for Wayland layer shell widgets
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

<p align="center">
  <img class="logo-dark" src="images/wordmark-light.svg" alt="GUIdo" height="120">
  <img class="logo-light" src="images/wordmark-dark.svg" alt="GUIdo" height="120">
</p>

# Guido

**A reactive Rust GUI library for Wayland layer shell widgets**

![Status Bar Example](images/status_bar.png)

Guido is a GPU-accelerated GUI library built with Rust and wgpu, designed specifically for creating Wayland layer shell applications like status bars, panels, overlays, and desktop widgets.

## Key Features

- **Reactive System** - Fine-grained reactivity inspired by SolidJS with signals, computed values, and effects
- **GPU Rendering** - Hardware-accelerated rendering using wgpu with SDF-based shapes for crisp anti-aliasing
- **Wayland Layer Shell** - Native support for layer shell positioning, anchoring, and exclusive zones
- **Multi-Surface Apps** - Create multiple surfaces (windows) that share reactive state
- **State Layer API** - Declarative hover/pressed states with automatic animations and ripple effects
- **Transform System** - Translate, rotate, and scale widgets with spring physics animations
- **Composable Widgets** - Build complex UIs from simple, composable primitives
- **Image Widget** - Display PNG, JPEG, WebP, and SVG images with GPU texture caching
- **Scrollable Containers** - Vertical and horizontal scrolling with customizable scrollbars

## Quick Example

```rust,no_run
# extern crate guido;
use guido::prelude::*;

fn main() {
    App::new().run(|app| {
        let count = create_signal(0);

        app.add_surface(
            SurfaceConfig::new()
                .width(300)
                .height(100)
                .background_color(Color::rgb(0.1, 0.1, 0.15)),
            move || {
                container()
                    .height(fill())
                    .layout(Flex::row().center())
                    .child(
                        container()
                            .padding(16.0)
                            .background(Color::rgb(0.2, 0.2, 0.3))
                            .corners(8.0)
                            .when_hovered(|s| s.lighter(0.1))
                            .when_pressed(|s| s.ripple())
                            .on_click(move || count.update(|c| *c += 1))
                            .child(text(move || format!("Clicked {} times", count.get())))
                    )
            },
        );
    });
}
```

## What Can You Build?

Guido is ideal for:

- **Status bars** - System information displays anchored to screen edges
- **Panels** - Application launchers and taskbars
- **Notifications** - Overlay popups and alerts
- **Desktop widgets** - Clocks, system monitors, media controls
- **Layer shell utilities** - Any Wayland layer shell application

## Platform Support

Currently, Guido supports **Wayland** on Linux with layer shell protocol. The library uses:
- `wgpu` for GPU-accelerated rendering
- `smithay-client-toolkit` for Wayland protocol handling
- `calloop` for event loop integration
- `glyphon` for text rendering

## Getting Started

Ready to build your first Guido application? Head to the [Installation](getting-started/installation.md) guide to set up your development environment.