Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Patterns

Composed chrome. rustdoc · source · icedtea · iced

Window recipes take children and tokens. nav_rail, tool_panel, workspace, sectioned_menu, and cascade_menu take A11y. iced 0.14 publishes the widget id only.

Dialogs

dialogs — A confirm / message / save sheet.

Constructor: pattern::dialog_sheet

source · icedtea

Pass A11y. Primary accept is required. DialogOpts holds cancel, extra actions, header icon, and a dim backdrop with 0–1 progress. Escape sends Cancel when that button is set. Native file dialogs go through icedtea::native_dialog (an iced Task).

List/detail

list-detail — A sidebar list beside a filling detail pane.

Constructor: pattern::list_detail

source · icedtea

Pass A11y. sidebar is layout::fixed or layout::FILL. Children fill their panes. Pass Direction so the list sits on the start side.

Inspector

inspector — Master, detail, and a side inspector in one row.

Constructor: pattern::inspector

source · icedtea

Pass A11y. Three panes. The application owns selection in the list.

Drawer

drawer — A compact-width side pane beside content.

Constructor: pattern::drawer

source · icedtea

Pass A11y. open is the committed pane. progress is 0 (gone) to 1 (220 dp). Closed at 0 paints content only. Escape closes an open drawer when on_close is set.

Workspace

workspace — Nested dock tree: splits, sash, tab groups, leaf chrome.

Constructor: pattern::workspace

source · icedtea

DockNode is the layout tree (save, restore, move_panel). pane is called with each leaf id so every leaf can hold application content. header is trailing chrome on that leaf (kind badge, close). Pass |_| None when the leaf has none.

Pass A11y.

Tool panel

tool-panel — Title chrome plus a Dock control.

Constructor: pattern::tool_panel

source · icedtea

Title plus body. on_dock is the Dock control. Empty body is title chrome only.

Pass A11y.

nav-rail — Compact destination list beside content.

Constructor: pattern::nav_rail

source · icedtea

Selected row uses the rail wash. Press emits the destination index. RailDest carries an optional icon and badge. expanded is the wide labeled rail; compact shows the icon or the first letter in a 72 px column. Empty items paint an empty column. Arrows move the selected destination when the rail is focused.

Pass A11y.

navigation — Sidebar beside content, or a stack with Back.

Constructor: pattern::navigation_view

source · icedtea

Pass A11y. NavStack is push / pop / replace. Pass window width. Breakpoint::from_width picks beside vs stacked. See Navigation.

Tab view

tab-view — Tabs plus a filling body.

Constructor: pattern::tab_view

source · icedtea

Pass A11y. Select and close messages. The application paints the body for the active tab.

Preferences

preferences — Searchable preference groups.

Constructor: pattern::preferences_page

source · icedtea

Pass A11y. PrefGroup is a title plus key/value rows. Empty query shows every group.

About

about — Name, version, license, and credits.

Constructor: pattern::about_page

source · icedtea

Pass A11y. Strings are the application’s. Catalog supplies chrome labels (Catalog::for_locale: English, Vietnamese, Japanese, Chinese, Arabic, Urdu).

Status page

status-page — Centered empty or error state.

Constructor: pattern::status_page

source · icedtea

Pass A11y. Title, body, and an optional action. Use when a list has no rows.

Command palette

palette — Fuzzy find over the action table.

Constructor: pattern::command_palette_view

source · icedtea

Pass A11y. CommandPalette owns the query and hits. Empty query shows favorites, then recent. Pass PaletteOpts for group headings, row face, empty omit, size, and highlight. A nested page or ask keeps the query field. progress fades and slides the panel. See Overlay windows.

Main window

main-window — Menu, toolbar, center, and status docked together.

Constructor: pattern::main_window

source · icedtea

Pass A11y. Pass the four regions as Elements. First window is the smaller form: toolbar plus one control.

Side sheet

side-sheet — Docked supporting pane over a dimmed scene.

Constructor: pattern::side_sheet

source · icedtea · iced

Pass A11y. end docks the trailing edge. Optional dismiss closes the sheet. progress fades the scrim and slides the pane.