Documentation

Build with guise.

Everything from installing the crate to embedding a native web view. Press ⌘ K to search, or start with the essentials.

Getting started

Installation →

Add the crate, install a theme, and render your first window.

Tutorial →

Build a SQL data workbench end to end — eleven chapters, one app.

Foundations

Theming →

The palette, scales, color scheme, and semantic colors.

Component model →

RenderOnce builders vs. stateful entities, variants, and events.

Components

Buttons →

Button, ActionIcon, CloseButton, ThemeIcon, and CopyButton.

Icons →

The Icon component and the IconName glyph set.

Inputs →

TextInput, Select, Combobox, NumberInput, Slider, Rating, and more.

Editor →

A multiline code editor: gutter, syntax highlighting, styling, highlights, and undo/redo.

Typography →

Text, Title, Anchor, Code, Kbd, Mark, and Spoiler.

Layout →

Stack, Group, SimpleGrid, Card, Paper, ScrollArea, and AppShell.

Panels →

Panel header/footer framing, and SplitPanel's draggable divider.

Feedback →

Alert, Loader, Progress, RingProgress, ToastStack, and Skeleton.

Data display →

Avatar, Badge, Table, TableView, DataView, TreeView, Tabs, and TabBar.

Charts →

Sparkline, BarChart, LineChart, and PieChart, painted on canvas.

Overlays →

Modal, ConfirmModal, Menu, ContextMenu, Popover, Spotlight, and Drawer.

Navigation →

Breadcrumbs, NavLink, Stepper, Pagination, and StatusBar.

WebView →

A native OS web view embedded via wry.

Systems

Flex layout →

Flutter-style Row, Column, Expanded, Container, and Wrap.

Layout macros →

The row! / col! / zstack! layout macros and style! / color!.

Transitions →

Transition and Collapse mount animations.

Reactive state →

Signal, Binding, context / provider, hooks, and FormState validation.

Window menu →

Wiring the native application menu.

Reference

Architecture →

Workspace layout, the gpui dependency, and adding a component.