A concise, practical reference for building applications with GPUI, the UI framework powering Zed.
This book complements the official GPUI documentation and gpui.rs examples by providing:
- Common patterns and recipes for everyday tasks
- Real-world examples beyond hello world
- Best practices from the Zed codebase
- Common pitfalls and how to avoid them
- Cookbook-style solutions to typical problems
The book is organized into several sections:
- Getting Started: Setup and fundamentals
- Common Patterns: State management, UI components, and layouts
- Styling: Styling system, theming, and animations
- Interactivity: Mouse, keyboard, and focus management
- Advanced Topics: Performance, async, custom elements, windows
- Integration: File systems, networking, persistence
- Cookbook: Complete feature examples
- Pitfalls & Best Practices: Common mistakes and solutions
- Reference: Quick reference guides
🚧 This book is a work in progress! 🚧
Most sections currently contain TODO placeholders. Contributions are welcome! Like the Bevy cheatbook in its early days, this book will be built incrementally by the community.
This book is built with mdBook.
# Install mdbook
cargo install mdbook
# Build the book
mdbook build
# Serve locally with live reload
mdbook serveContributions are welcome! Whether you want to:
- Fill in TODO sections
- Add new examples
- Fix errors or improve clarity
- Suggest new topics
Please feel free to open issues or pull requests.
- Inspired by the Bevy Cheat Book
- Built for the GPUI community