gpui

name

gpui

description

GPUI framework knowledge covering actions/keybindings, async/background tasks, context management (App/Window/Context<T>/AsyncApp), custom elements (low-level Element trait), entity state management, event system, focus handling, global state, layout/styling (flexbox/CSS-like), and testing. Use when working with any GPUI framework concept, building GPUI applications, or needing guidance on GPUI-specific APIs and patterns.

Navigation

Load the relevant reference file based on the task:

Topic	File	When to load
Actions & keybindings	action.md	actions!, bind_keys, on_action, key_context
Async & background tasks	async.md	cx.spawn, background_spawn, Task, async I/O
Context management	context.md	App, Window, Context<T>, AsyncApp
Custom elements (low-level)	element.md	Element trait, request_layout, prepaint, paint
Entity state	entity.md	Entity<T>, WeakEntity, state management
Events & subscriptions	event.md	cx.emit, cx.subscribe, cx.observe
Focus & keyboard nav	focus-handle.md	FocusHandle, track_focus, Tab navigation
Global state	global.md	Global trait, cx.set_global, app-wide config
Layout & styling	layout-style.md	div(), h_flex(), v_flex(), flexbox, overflow, positioning
ElementId	element-id.md	ElementId, .id(), uniqueness rules, stateful elements
Testing	test.md	#[gpui::test], TestAppContext, VisualTestContext

Extended References

For deep-dive topics, additional reference files are available:

Element trait:

• element-api.md — complete API, hitbox system, event handling
• element-patterns.md — text, interactive, container, composite patterns
• element-examples.md — full examples: text, interactive, complex elements
• element-best-practices.md — performance, state, common pitfalls
• element-advanced.md — masonry/circular layouts, async updates, virtual lists

Entity management:

• entity-api.md — complete Entity API, methods, lifecycle
• entity-patterns.md — model-view, cross-entity communication, observer
• entity-best-practices.md — memory, performance, lifecycle
• entity-advanced.md — collections, registry, debounce, state machines

Testing:

• test-examples.md — testing examples and patterns
• test-reference.md — complete testing API reference