Chrome
Theme, marks, rows, and feedback. rustdoc · source · icedtea · iced
Widget constructors on this page take A11y. Menu, toolbar, status,
command bar, and cheatsheet take the action table. layout::pack and
layout::wrap do not. iced 0.14 publishes the widget id only.
Colorways
theme::named
looks up a built-in colorway.
source ·
icedtea
Unknown names resolve to dark, the desktop pair with light.
Persist defaults follow-OS on that pair. Register more on
ThemeCatalog. Density, type scale, corners, and elevation live on
Tokens (with_density, with_font_scale, with_shape,
with_elevation) and restore from UiState::look. See
Theming.
Washes
theme::mix
blends two colors for washes.
source ·
icedtea
amount 0 is the background, 1 is the foreground. Hover, pressed,
and selection washes use this.
Shortcuts
key::handle
resolves a key event against the action table.
source ·
icedtea
Subscribe with key::listen.
run! already does. Implement From<keyboard::Event> on the
application message. An open modal consumes. Focused text owns
unmodified typing. Otherwise the focused constructor owns arrows,
Enter, and Space. Tab walks focus::cycle. Otherwise chords match
the table. See Actions and
Architecture.
Cheatsheet
cheatsheet — A searchable shortcut list from the action table.
Constructor: pattern::cheatsheet
Pass A11y. Empty query lists every enabled action. Disabled actions
stay out.
Card
card — A titled panel around children.
Constructor: widget::group_box
Same constructor as group-box. CardFace is elevated, filled,
outlined, or rail (inset start rail and a label gutter). An optional
trailing child sits on the header end. Empty title is a border only.
Pass A11y.
Rule
rule — A horizontal divider.
Constructor: widget::rule_h
rule_v is the vertical twin.
Pass A11y.
Chip
chip — A compact labeled pill.
Constructor: widget::chip
ChipKind is assist, filter, input, or suggestion. Optional icon,
press, and dismiss. META type, chip wash, shrink width. Disabled keeps
the face and drops press.
Pass A11y.
Badge
badge — A count or status mark.
Constructor: widget::badge
BadgeSize is small or large. Both use meta type. Corners follow
Tokens.shape. Pass a host element to overlap the mark on an icon.
Empty string is an empty mark.
Pass A11y.
Pack
pack — Measure children and allocate leftover on one row or column.
Constructor: layout::pack
Pass Slot::hug and Slot::share. Pack places leftover stretch
does not take (start, end, center, between). Empty slots yield an
empty box. Direction mirrors a horizontal box.
Wrap
wrap — Measure children and start a new line when the next does not fit.
Constructor: layout::wrap
Pass slots, gap, and direction. Do not pass a uniform child width or the parent width. Empty slots yield an empty box. Share slots with a min width reflow how many sit on a line.
Banner
banner — A page-level message with an optional action.
Constructor: widget::banner
Use for “offline” or “update available”. Optional button message.
tone paints a callout wash.
Pass A11y.
Command bar
command-bar — The toolbar row, denser.
Constructor: pattern::command_bar
Same Action iterator as toolbar. Disabled actions paint muted.
Context menu
context-menu — Action list under the pointer.
Constructor: pattern::context_menu
Pass A11y. Stack on the window with the click point. Click-away
and Escape dismiss. Rows fill the card. Empty table still paints a
card. progress is 0 (gone) to 1 (rest).
Breadcrumb
breadcrumb — A path of links.
Constructor: widget::breadcrumb
Crumbs before the last send a message. The last crumb is the current page. Empty path is empty. Arrows move along the path when the trail is focused.
Pass A11y.
Menu
menu — An in-window menu bar from one action table.
Constructor: pattern::menu_bar
Groups by the id prefix before . (file.save → File). Disabled
actions stay out of the pick list. on_open publishes true when a
title opens and false on Escape or a pick so
KeyContext.modal_open follows the model.
Toolbar
toolbar — A row of action buttons.
Constructor: pattern::toolbar
First window uses this with file.save.
Direction comes from Boot.
Status bar
status-bar — Footer text plus shortcut hints from the table.
Constructor: pattern::status_bar
Left is status copy (label with LabelFace::Meta, or banner when a tone is set). Right
is each enabled shortcut as two faces (chord in Tokens.text, title
in Tokens.muted at meta size), or an optional caption string. An
empty table shows status only. ActionTable::footer_hints returns
the joined strings (j down) for tests. A click on a hint chord
invokes the same Action.
Scrollbar
scrollbar — A themed scroller with a usable handle.
Constructor: widget::scroll
Lists and tables use a 24px rail. The rail sits on the end side
(Tokens.direction: right in left-to-right, left in right-to-left).
This constructor is the themed
iced scroller for other panes.
A focused pane moves with arrows, Page, Home, and End. It does not
paint a focus ring.
Pass A11y.
Toast
toast — A transient notice.
Constructor: widget::toast_view
The application owns the Toast queue and dismiss. Empty queue
paints nothing. Enter and the last slice of TTL fade through
motion::overlay.
Pass A11y.
Busy overlay
busy — Dim plus spinner over a child.
Constructor: widget::busy_overlay
When busy is false the child is unmodified. Advance spinner
phase while true.
Pass A11y.
Motion
motion — Fade and slide a child for overlay enter/exit.
Constructor: motion::overlay
progress is 0 (gone) to 1 (rest). Hold a motion::Run
for Job::Enter
(dialog, menu, sheet, toast, tooltip). Slide::None is fade only:
build the child with Tokens::fade. Reduced-motion tokens snap to
0 or 1. See Motion.
Pass A11y.
Switch motion
switch-motion — Replace one child with another.
Constructor: motion::switch
SwitchFace::SharedAxis is next/previous peers (timeline j/k):
incoming uses progress on that slide, leaving uses 1 - progress
on the opposite slide, travel is 12 dp. SwitchFace::FadeThrough is
tab bodies and other unrelated destinations. Build each child with
Tokens::fade from incoming_fade / outgoing_fade. Child overlays
(pick lists) still open.
Pass A11y.
Attention motion
attention-motion — Shake or pulse a child.
Constructor: motion::attention
AttentionFace::Shake is an invalid field. AttentionFace::Pulse
is a live mark. Reduced-motion tokens hold rest.
Pass A11y.
Expand motion
expand-motion — Clip a child between a peek size and its open
size on one axis.
Constructor: motion::expand
Axis::Block is height (expander, accordion, tree). Axis::Inline
is width (drawer). progress 0 is the peek; 1 is the laid-out size.
Pass A11y.
Filter chips
filter-chips — Multi-select filter chip set.
Constructor: widget::filter_chips
The application owns which indices are on. Press toggles one chip.
Pass A11y.
Sectioned menu
sectioned-menu — Menu list with optional section titles and dividers.
Constructor: pattern::sectioned_menu
Pass MenuSection groups of actions.
Pass A11y.
Cascade menu
cascade-menu — Two-level menu with an optional open submenu.
Constructor: pattern::cascade_menu
The application owns which primary row is expanded. sub_progress
is 0 (gone) to 1 (rest) for that panel.
Pass A11y.