Rust Gpui Development

Rust GPUI Development

Patterns and API reference for building Rust applications with the GPUI framework.

Reference Files

Load based on current task:

Quick Reference

GPUI Context Types

View Structure

pub struct MyView {
    focus_handle: FocusHandle,
}

impl Render for MyView {
    fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
        div()
            .key_context("MyView")
            .on_action(cx.listener(Self::handle_action))
            .child(/* ... */)
    }
}

impl MyView {
    fn handle_action(&mut self, _: &MyAction, window: &mut Window, cx: &mut Context<Self>) {
        cx.notify();
    }
}

Actions

// Simple actions
actions!(my_namespace, [DoSomething, Cancel]);

// Parameterized actions
#[derive(Clone, PartialEq, Deserialize, JsonSchema, Action)]
#[action(namespace = my_namespace)]
pub struct SelectItem { pub index: usize }

// Register in render() via cx.listener()
div().on_action(cx.listener(Self::handle_action))

Global State

impl Global for AppSettings {}
cx.set_global(AppSettings::new());
let settings = cx.global::<AppSettings>();
cx.observe_global::<AppSettings>(|this, cx| { cx.notify(); }).detach();

Critical Rules

1. Never store cx - always pass through method parameters
2. Call .detach() on subscriptions and observations
3. Call cx.notify() after state changes that affect rendering
4. Use cx.listener() for action/click handlers in render() - wraps entity access
5. window: &mut Window is a separate parameter in all entity callbacks

Converted and distributed by TomeVault — claim your Tome and manage your conversions.