mirror of
https://github.com/storytold/craft-libs.git
synced 2026-11-16 22:14:30 +00:00
36 KiB
36 KiB
Built components
Generated by cargo run -p craft-ui-gallery --bin components-index; edit the doc comments, not this file.
Registered types
| Type | Shape | Module | Purpose |
|---|---|---|---|
Canvas<'_> |
Body | craft_ui_canvas::canvas |
A canvas: a pasteboard the caller's canvas controls and the active tool share |
CropOverlay<'_> |
Leaf | craft_ui_canvas::canvas::crop |
The crop frame of a document, edited by dragging it as Photoshop's Classic crop does (or moving and turning the image behind it in image mode) and by the keyboard |
FullWindowDialog<'_> |
Body | craft_ui_canvas::canvas::full_window |
A dialog that fills the window: a title row, a body that takes the room between the header and the footer, and an optional footer |
FullWindowCanvas<'_> |
Pattern | craft_ui_canvas::canvas::full_window_parts::canvas |
The canvas region of a full-window dialog: the app's image, its overlays and one tool, filling what the other regions left |
FullWindowSide |
Body | craft_ui_canvas::canvas::full_window_parts::side |
A side column of a full-window dialog: Liquify's and Select and Mask's Properties, Content-Aware Fill's Preview and settings panels, Filter Gallery's settings |
FullWindowStatus |
Pattern | craft_ui_canvas::canvas::full_window_parts::status |
The status of a preview over a [Pending]: nothing while it is ready, a progress bar (with the polite label "Updating preview") while it loads, a notice with the error while it failed and a notice that the preview is unavailable when its job ended without delivering |
FullWindowTitle |
Pattern | craft_ui_canvas::canvas::full_window_parts::title |
The title strip's text: the workspace's name, then in brackets what it works on and the zoom on screen, "Liquify (Layer 1, 66.67%)" |
FullWindowZoomBar<'_> |
Pattern | craft_ui_canvas::canvas::full_window_parts::zoom_bar |
The strip under a full-window canvas: Zoom Out, Zoom In, a zoom select, then a progress bar while the preview renders, or a note |
Navigator<'_> |
Leaf | craft_ui_canvas::canvas::navigator::preview |
The preview box of the Navigator panel with the proxy rectangle of the view |
NavigatorZoomRow<'_> |
Pattern | craft_ui_canvas::canvas::navigator::zoom_row |
The Navigator's zoom row: a percent field, Zoom Out, a slider over the whole zoom range and Zoom In, in reading order |
NavigatorPanel<'_> |
Pattern | craft_ui_canvas::canvas::navigator_panel |
The Navigator panel (Photoshop's Window, Navigator): the [Navigator] preview box over the [NavigatorZoomRow], both bound to one view |
Pasteboard<'_> |
Leaf | craft_ui_canvas::canvas::pasteboard |
The pasteboard and page frames under a document |
RasterDisplay<'_> |
Leaf | craft_ui_canvas::canvas::raster |
The CPU raster display of one canvas: the document drawn through the view of the Canvas it is shown in, at the canvas rect |
RotateView<'_> |
Leaf | craft_ui_canvas::canvas::rotate |
The compass of a turned view: a dial whose needle points where the document's up lies on screen |
Rulers<'_> |
Leaf | craft_ui_canvas::canvas::rulers |
The rulers of a canvas: ticks and labels counted from a zero point, level whatever the view's rotation, a pointer marker, the guide drag-out and the zero point's corner |
CanvasScrollbars<'_> |
Leaf | craft_ui_canvas::canvas::scrollbars |
The scroll bars of a canvas |
SplitViews<'_> |
Body | craft_ui_canvas::canvas::split |
One canvas area divided into 1, 2 or 4 panes |
TipCell |
Leaf | craft_ui_canvas::canvas_controls::brush::cursor |
An aliased tip's whole-pixel cell on the pixel grid, outlined as a square or a disc: what a pencil shows under the hidden pointer |
FalloffPreview<'_> |
Leaf | craft_ui_canvas::canvas_controls::brush::falloff |
A tip's falloff centred at a document point, with the circle of the brush's size round it: the preview a brush resize and a hover show |
CanvasGrid |
Leaf | craft_ui_canvas::canvas_controls::grid |
Major and minor grid lines over a document, counted from origin |
Guides<'_> |
Leaf | craft_ui_canvas::canvas_controls::guides |
The ruler guides of a canvas: drawn, taken by the pointer and moved with the keyboard |
StraightLinePreview |
Leaf | craft_ui_canvas::canvas_controls::line_preview |
The Shift-click line from from (the end of the last stroke) to to (the pointer), both in document units |
Marquee |
Leaf | craft_ui_canvas::canvas_controls::marquee |
An outline over the document, shown at the canvas's rect with show_at and mapped through the canvas's view |
HoverOutline |
Leaf | craft_ui_canvas::canvas_controls::outline |
The outline of the object under the pointer: decoration over the canvas, drawn after the document and before the tool's own marks |
SelectionOutline<'_> |
Leaf | craft_ui_canvas::canvas_controls::outline |
Highlights over the selected shapes, in the host's colour (a layer's colour), else the overlay line colour |
PixelGrid<'_> |
Leaf | craft_ui_canvas::canvas_controls::pixel_grid |
The pixel grid over a raster document |
SmartGuides<'_> |
Leaf | craft_ui_canvas::canvas_controls::smart_guides |
The alignment lines and distances an app shows while something moves (Smart Guides and Alt distances) |
HeaderText |
Leaf | craft_ui_contract::contract::items::header |
A header cell's label |
LabelLeaf |
Leaf | craft_ui_contract::contract::label::leaf |
The side label as a leaf: its own node, press state and reset dot |
TipText<'_> |
Leaf | craft_ui_contract::contract::tooltip |
The text of a tooltip, on a popup surface |
Alert<'_> |
Pattern | craft_ui_panels::dialog::alert |
A modal notice with one OK button: a prompt whose only answer is OK, which OK, Enter, Escape and the close action all give |
BlockingOverlay<'_> |
Body | craft_ui_panels::dialog::blocking |
A modal layer that takes the window's input while it is shown, with the wait cursor |
DialogFrame<'_> |
Body | craft_ui_panels::dialog::frame |
The look of a dialog in the flow of its parent: the dialog surface, a title row, the body and a footer |
Dialog<'_> |
Body | craft_ui_panels::dialog::modal |
A dialog on its own layer |
ModalDragStrip |
Body | craft_ui_panels::dialog::modal |
The chrome a modal dialog puts over a drag area of the window it covers, so that the window still moves by it |
Prompt<'_> |
Pattern | craft_ui_panels::dialog::prompt |
A question with answers: a dialog on the modal preset, centred and not movable, with a message, optional extras and one footer button per answer |
StandardPrompt |
Pattern | craft_ui_panels::dialog::prompts |
A standard confirmation on the dialog host: a prompt with the platform's button order, a letter on every answer and, with dont_show_again, a check box under the message |
RecoveryDialog |
Dialog | craft_ui_panels::dialog::recovery |
Recover Unsaved Work, one document at a time: a prompt saying when the document was autosaved, with Discard and Recover (the accepting answer) |
UnsavedChangesDialog |
Pattern | craft_ui_panels::dialog::unsaved |
The question for one modified document: a prompt titled "Unsaved changes" with the document's name in the message, Save (the accepting answer), Don't Save and Cancel in the platform's order and words, and, while the guard has more documents, an "Apply to All" check box |
SplitArea<'_, usize> |
Body | craft_ui_panels::docking |
The docked tree of a layout, with a handle between neighbouring groups |
DockColumn<'_, u8> |
Body | craft_ui_panels::docking::dock_column |
One column of a side dock: the column bar over the stacked groups of column |
FloatingGroup<'_> |
Body | craft_ui_panels::docking::floating |
A floating dock group: a titled window the user moves by its title, resizes by its edges and corners, and minimizes by a double click on the title |
Flyout |
Pattern | craft_ui_panels::docking::flyout |
A popup beside an iconic column, on the side of the canvas, level with the icon that opened it |
DockGroup<'_, usize> |
Body | craft_ui_panels::docking::group |
A group of panels: a header of tab strip and panel menu button, dragged by its empty part, over the active panel's body |
GroupGrip<usize> |
Leaf | craft_ui_panels::docking::group |
The handle a group is dragged by: an unmarked band over the empty room of the group's header |
IconicColumn<'_, u8> |
Body | craft_ui_panels::docking::iconic |
A column collapsed to icons: the column bar over icon groups, one cell per panel |
DockRoot<'_, ()> |
Body | craft_ui_panels::docking::root |
The room of a docking pattern: it fills the room offered, resolves the docking sizes its body reads, and takes the drops released on it |
Splitter |
Leaf | craft_ui_panels::docking::splitter |
A line between two panes, as thick across as the pointer's grab distance |
StackSections |
Body | craft_ui_panels::docking::stack |
An accordion laid out in the rect it is shown at (section_heights with the strip height of the docking sizes), with a divider between its open sections |
WindowMenuRows<'_, u32> |
Pattern | craft_ui_panels::docking::window_menu |
One check row per panel in the order the app gives, for a Window menu |
ToolbarDrawer<'_, u8> |
Pattern | craft_ui_panels::rails::drawer |
The All Tools drawer: a popover beside the rail with one list over all groups, a heading row for each group |
FlyoutButton<'_, u8> |
Leaf | craft_ui_panels::rails::flyout |
One rail button that may stand for a group of tools |
PanelRail<'_, u8> |
Body | craft_ui_panels::rails::panel_rail |
The rail of icons that open panels, as a side panel at one edge of the window |
ToolRail<'_, u8> |
Body | craft_ui_panels::rails::tool |
The rail of tool slots, as a side panel at one edge of the window: one FlyoutButton per visible slot showing the slot's shown tool, the slot with the current tool toggled on |
DropAction<u8> |
Body | craft_ui_panels::sections::footer |
A container that is as large as its one child and takes drops of payload type P over that child |
FooterBar |
Body | craft_ui_panels::sections::footer |
A footer region's content: its body is the caller's closure, and its members are one roving group |
GroupBox<'_> |
Body | craft_ui_panels::sections::group_box |
A frame around a body, titled by the container's label |
Panel<'_> |
Body | craft_ui_panels::sections::panel |
A panel of a workspace: title row, scrolling body, optional footer |
ReorderableSections<'_> |
Pattern | craft_ui_panels::sections::reorderable |
Sidebar sections the user folds, hides, pins and reorders, over the host's [SectionLayout] |
Section<'_> |
Body | craft_ui_panels::sections::section |
An inline section of a panel that fills the width offered: a rule over a section-strength title row over a body |
SectionStack<'_, u8> |
Body | craft_ui_panels::sections::stack |
Sections in the order of order, each shown by the caller's closure as a Section::in_stack |
TitleRow<'_> |
Leaf | craft_ui_panels::sections::title_row |
An optional icon, a title with an optional subtitle, a lead (a disclosure bound to the container's open state, or a check box bound to its gate) and action parts |
DockArea<'_, usize> |
Pattern | craft_ui_patterns::patterns::dock::area |
The docking pattern over a workspace |
PaneArea<'_, u32> |
Pattern | craft_ui_patterns::patterns::dock::panes |
The app's side panes, bottom panes and floating panes around its document |
PaneFrame<'_> |
Body | craft_ui_patterns::patterns::dock::panes |
A docked pane: a shell pane on one edge of the area, with a title row and a scrolling body |
WorkspaceSwitcher<'_, u32> |
Pattern | craft_ui_patterns::patterns::dock::switcher |
The switcher at the end of an options bar: a small select showing the current workspace's name |
AboutDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::about |
Help > About: tabs About, Contributors and Models over the app's [AboutInfo] and [Credits], with an OK button |
ParamDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::dialog |
A dialog from a parameter list: one row per [Param], the Preview check box with a preview pane when the host gives a picture, and OK, Cancel and a footer extra |
ExportAsDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::export::as_dialog |
File, Export, Export As: format, size, quality, metadata, colour profile, a preview and a size estimate the app computes |
FormatOptionsDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::export::options |
The options dialog of one export format: JPEG (the quality as a field, a slider and a preset list, then the encoding), layered TIFF (keep or discard the layers, and not to ask again), Targa (24 or 32 bits per pixel) or DDS (compression and mipmaps) |
OutputPathRow<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::export::path_row |
"Output To", a list of name templates ([Comp Name].[fileExtension]) and the chosen path in a text field with a Browse button, for render queues and export dialogs |
FormDialog<'_, bool> |
Pattern | craft_ui_patterns::patterns::form_dialogs::form |
A dialog over one value V |
GuideLayoutDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::guides |
New Guide Layout, Photoshop's dialog: Preset and Target lists, Color, the Columns and Rows groups (each a check box with Number, Width or Height, and Gutter), the Margin group (a check box and Top, Left, Bottom, Right), Center Columns and Clear Existing Guides; OK, Cancel and Preview |
NewGuideDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::guides::new_guide |
New Guide, and Edit Selected Guides when it edits a guide: an orientation, a position with a unit and a colour |
ListManager<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::list_manager |
A named list with a name box and a column of action buttons (after Excel's Macros dialog) |
NavigatorOptionsDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::navigator_options |
Panel Options of the Navigator: the colour of the proxy rectangle |
NewDocumentDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::new_document |
File > New: category tabs over a grid of preset cards, a details column and Create and Close |
PasswordDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::password |
A question with a lock icon, the message, the masked field and the buttons |
PdfExportDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::pdf_export |
File > Save as PDF: a preset row, Standard and Compatibility, and a list of sections (General, Compression, Marks and Bleeds, Output, Advanced, Security and Summary) beside the shown section |
PreviewPane<'_> |
Leaf | craft_ui_patterns::patterns::form_dialogs::preview |
A picture in a well, over a checkerboard where it is transparent |
PreviewZoom |
Pattern | craft_ui_patterns::patterns::form_dialogs::preview |
The zoom row of a preview: a zoom-out button, the zoom as a percentage and a zoom-in button |
PropertiesDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::properties |
A properties dialog: a TabStrip over the tabs (none with one tab) and the rows of the shown tab as one ParamRows over the values of all of them |
ReportDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::report |
A report: the title, one summary line, the count of notes, the notes with their tone icons and, in the footer, Copy and OK |
ParamRows<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::rows |
The rows of a parameter list: a group of one labelled field per visible [Param], the control chosen by its [ParamKind], in a panel the host lays out or inside a dialog |
SaveForWebDialog<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::save_for_web |
The Save for Web dialog: the view tabs over a row of preview panes that share one view, the zoom row, the animation row, and the settings column |
CanvasSize<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::sizing::canvas |
Canvas Size: the current size, the new width and height with a unit each (no chain: the sides are independent), the Relative box, the 3 by 3 anchor and the colour that fills a larger canvas |
ImageSize<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::sizing::image |
Image Size: the width, height and resolution with a unit each, the chain that keeps the proportions, Resample with its method list and Scale Styles, over a readout of the file size and the dimensions |
Watermark<'_> |
Pattern | craft_ui_patterns::patterns::form_dialogs::watermark |
The watermark rows of an export dialog: Style (Text, Graphic), the text field or the image path with Choose…, Orientation, Position as the 3 by 3 reference point, Rotation, Size, Opacity, Inset X and Y, and Shadow |
Inspector<'_> |
Pattern | craft_ui_patterns::patterns::panels::inspector |
A properties panel: a Panel whose header names the target (icon, name and, after it, the kind), and whose body the caller fills with the target's controls |
CommandPalette<'_> |
Pattern | craft_ui_patterns::patterns::panels::palette |
A search over the app's commands in a centred modal box: a search field over the matching commands |
Tour<'_> |
Pattern | craft_ui_patterns::patterns::panels::tour |
A guided tour of the interface: a card with the step's heading and text, Skip, Back and Next (Done on the last step) and the step count, beside the part the step points at, with the rest of the window dimmed |
PreferencesWindow<'_> |
Pattern | craft_ui_patterns::patterns::preferences::window |
The preferences window: a search field over a page list and the shown page, with OK, Cancel and Apply under them |
PresetBrowser<'_, u32> |
Pattern | craft_ui_patterns::patterns::presets::browser |
A library of named presets shown as thumbnails |
PresetFooter<'_, u32> |
Pattern | craft_ui_patterns::patterns::presets::footer |
The footer of a preset panel: the host's own controls, the thumbnail size slider and the count, then the action buttons Delete, New and New Group and the host's own actions |
NamedPresetRow<'_, u32> |
Pattern | craft_ui_patterns::patterns::presets::named |
A preset picker with the commands that make, rename and delete presets |
PresetPicker<'_, u32> |
Leaf | craft_ui_patterns::patterns::presets::picker |
A field that shows the current preset and opens its presets |
AppShell<'_, ()> |
Pattern | craft_ui_shell::shell::app_shell |
The window skeleton |
ShellRegion |
Body | craft_ui_shell::shell::app_shell |
A region of the window skeleton: the root window's content, the scope that carries the shell to its slots, or one pane (a bar, a rail or the body) |
CanvasPanel<'_> |
Pattern | craft_ui_shell::shell::canvas_shell |
The canvas panel of a dock: the panel rail at the end edge, spanning the tabs and the document; then, in what is left, the document tab strip flush against the document; then the document area, which the shell's backdrop shows through |
CaptionButton<'_> |
Leaf | craft_ui_shell::shell::caption_button |
One caption button of a title bar |
DocumentWindow<'_> |
Body | craft_ui_shell::shell::document_window |
A document's window: the container of one entry of the app's window list, in its own OS window |
StartScreen<'_> |
Pattern | craft_ui_shell::shell::start |
The start screen, shown in a shell's body when no document is open |
TitleBar<'_> |
Body | craft_ui_shell::shell::title_bar::bar |
The bar of a window whose frame the app draws |
ViewportWindow |
Pattern | craft_ui_shell::shell::viewport_window |
A window of the app with a body the app fills |
AlignBar |
Pattern | craft_ui_widgets::bars::align |
The align buttons, the optional distribute buttons and the menu button, shown as children of a Bar |
Bar<'_> |
Body | craft_ui_widgets::bars::bar |
A bar over a chrome surface whose body holds the members in reading order at the small control size |
BreadcrumbBar<'_, u8> |
Leaf | craft_ui_widgets::bars::breadcrumb |
A path of crumbs, the root first |
ConstraintFields<'_> |
Pattern | craft_ui_widgets::bars::constraint_fields |
The Style, Width, swap and Height cells of an options Bar that read and write a marquee's [Constraint] (Photoshop's Rectangular Marquee bar, the Slice tool's) |
BarItems |
Leaf | craft_ui_widgets::bars::items |
A strip of command items |
StatusReadout<'_> |
Pattern | craft_ui_widgets::bars::status_readout |
The zoom field, the chosen item's text and the menu that chooses it, shown as children of a status Bar |
Button<'_> |
Leaf | craft_ui_widgets::buttons::button |
A push button |
IconButton<'_> |
Leaf | craft_ui_widgets::buttons::icon_button |
A square button showing only an icon |
Link |
Leaf | craft_ui_widgets::buttons::link |
A link: drawn in the accent colour in a type role (body by default) and underlined, so colour is not its only cue |
SplitButton<'_, u8> |
Leaf | craft_ui_widgets::buttons::split_button |
A button whose end opens a menu |
ToggleButton<'_> |
Leaf | craft_ui_widgets::buttons::toggle_button |
A secondary-looking button that stays pressed while on: it takes the accent fill and edge, and its raised surface draws pressed in |
Checkbox<'_> |
Leaf | craft_ui_widgets::choice::check |
A check box over a bool; a Mixed binding shows the mixed state and a click makes it checked |
Radio<u8> |
Leaf | craft_ui_widgets::choice::radio |
A member of a RadioGroup: selected when the group's pick is its value |
RadioGroup<'_, u8> |
Body | craft_ui_widgets::choice::radio |
A group of radio buttons over one value: one Tab stop, arrows move focus, Space or a click selects |
Rating<'_> |
Leaf | craft_ui_widgets::choice::rating |
A rating over a u8 from 0 (unrated) to max |
Segment |
Leaf | craft_ui_widgets::choice::segmented |
What a segment of a Segmented shows: a label, or an icon with the label as its tooltip and name |
Segmented<'_, u8> |
Leaf | craft_ui_widgets::choice::segmented |
A row of segments over one value |
Swatch<u8> |
Leaf | craft_ui_widgets::choice::swatch |
A colour well that shows a colour from data and reports its activation; it edits nothing |
Switch<'_> |
Leaf | craft_ui_widgets::choice::switch |
A switch over a bool; a Mixed binding rests the thumb in the middle and a click turns it on |
Disclosure<'_> |
Leaf | craft_ui_widgets::controls::disclosure |
A button bound to an open state, with the expanded state |
Badge |
Leaf | craft_ui_widgets::display::badge |
A small label in a tone: a soft tint by default, a solid fill with a solid variant |
Divider |
Leaf | craft_ui_widgets::display::divider |
A separator line in the divider colour, snapped to the pixel grid |
Icon<'_> |
Leaf | craft_ui_widgets::display::icon |
An icon |
Kbd |
Leaf | craft_ui_widgets::display::kbd |
A key chord |
Picture<'_> |
Leaf | craft_ui_widgets::display::picture |
A picture of an image the caller makes |
Progress |
Leaf | craft_ui_widgets::display::progress |
A progress bar |
Spinner |
Leaf | craft_ui_widgets::display::spinner |
The busy mark |
Text |
Leaf | craft_ui_widgets::display::text |
Text in a type role (body by default) and a shade (normal by default), or in the colour of a tone |
Field |
Body | craft_ui_widgets::form::field |
One control with a side label: beside it, above it, as a caption or after it (Field::layout) |
FieldGroup |
Body | craft_ui_widgets::form::group |
A stack of Fields (and LinkedFields) named label, filling the width offered |
SliderField<'_> |
Leaf | craft_ui_widgets::form::slider_field |
A caption and number field over a full-width slider, on one value |
NodeGraph<'_> |
Items | craft_ui_widgets::graph |
A graph of nodes at stored positions, joined by wires |
Node<'_> |
Leaf | craft_ui_widgets::graph::node |
A node of a kind: a title, ports, the kind's inline controls and its body paint |
Grid |
Body | craft_ui_widgets::layout_components |
Children row-major over a column list: a child in flow takes the next cell |
Row |
Body | craft_ui_widgets::layout_components |
Children side by side |
Stack<'_> |
Body | craft_ui_widgets::layout_components |
Children one under another |
EventList<'_> |
Items | craft_ui_widgets::list::events |
The list of events: one selected event; an empty log says so |
FindingsList<'_> |
Items | craft_ui_widgets::list::findings |
The list of findings: one selected finding, Enter activates, and an empty list says so |
FindingsSummary<'_> |
Leaf | craft_ui_widgets::list::findings |
The line over a list of findings: an icon that says whether there are errors, then the counts |
ListRow<'_> |
Leaf | craft_ui_widgets::list::row |
One row of a list |
RowThumb<'_> |
Leaf | craft_ui_widgets::list::row::thumb |
The picture of a row's thumbnail, painted by the host through the content painter, which is clipped to the thumbnail's rect |
UndoList<'_> |
Items | craft_ui_widgets::list::undo |
The undo list: one Tab stop, arrows mark rows through the row, Enter or a click picks it |
List<'_, usize> |
Items | craft_ui_widgets::list::view |
A list of rows: one Tab stop, the selection rules of the collection contract, type-ahead on the rows' text, rename in place, drag to reorder, and the request for the app's context menu |
MenuBar<'_> |
Leaf | craft_ui_widgets::menu::bar |
A menu bar |
TitleFace |
Leaf | craft_ui_widgets::menu::bar |
The face of a menu title: lit while its menu is open or the keyboard is on it |
EditMenu |
Pattern | craft_ui_widgets::menu::edit |
The edit rows of a text control: Undo and Redo, Cut, Copy, Paste and Delete, then Select All |
MenuItem<'_> |
Leaf | craft_ui_widgets::menu::item |
A row of a menu: a label, an optional icon, a check or radio mark, shortcut text and a detail |
PanelMenu |
Pattern | craft_ui_widgets::menu::panel |
The rows of one panel's menu: the host's rows, a separator, then the dock's rows |
Menu<'_> |
Body | craft_ui_widgets::menu::popup |
A menu: a popup of [MenuItem]s and [Divider]s the arrow keys move through, one roving group |
NoticeCenter |
Pattern | craft_ui_widgets::notices::center |
The app's way to post notices |
Notice<'_> |
Leaf | craft_ui_widgets::notices::notice |
A message in a tone |
SettingsNotices |
Pattern | craft_ui_widgets::notices::settings |
The notices a SettingsNoticeState calls for, newest problem first: an error notice when saving keeps failing and a warning when stored settings were reset |
ToastStack |
Pattern | craft_ui_widgets::notices::toasts |
The cards of the toast queue |
ComboBox<'_> |
Leaf | craft_ui_widgets::pickers::combo_box |
A text field with a list of options |
DatePicker<'_> |
Leaf | craft_ui_widgets::pickers::date |
A text field for a date with a calendar popover |
Calendar |
Leaf | craft_ui_widgets::pickers::date::calendar |
The page of a date picker's popover |
SelectFace<'_> |
Leaf | craft_ui_widgets::pickers::face |
The closed box of a picker: text elided to the room left of a trailing chevron |
IconPicker<'_, u8> |
Pattern | craft_ui_widgets::pickers::icon_picker |
A searchable grid of icons in named groups |
ReferencePoint<'_> |
Leaf | craft_ui_widgets::pickers::reference_point |
The 3 by 3 picker of a box's nine points: the point a transform, a resize or a watermark works about |
Select<'_, u8> |
Leaf | craft_ui_widgets::pickers::select |
A field that shows the picked entry and opens a listbox of all of them |
TreePicker<'_, u32> |
Leaf | craft_ui_widgets::pickers::tree_picker |
A field that opens a tree of items and folders and sets the binding to the picked item's key |
UnitSelect<'_> |
Leaf | craft_ui_widgets::pickers::unit_select |
A number field with a select of units after it |
Popover<'_> |
Body | craft_ui_widgets::popover::anchored |
A non-modal popup that hangs from the control that opened it and holds the app's body (a colour picker, a stroke editor, a settings form) |
DropVeil |
Body | craft_ui_widgets::popover::drop_veil |
A body that dims and shows label on a card while the OS drags files over the window, and reports the files dropped on the window |
VeilCard |
Leaf | craft_ui_widgets::popover::drop_veil |
The card of a veil: a popup surface around the label's Text, as wide and high as the text with its padding |
PopupList<'_> |
Body | craft_ui_widgets::popover::popup_list |
A list popup under a field the app owns (a combo, a history picker) |
MetadataTable<'_> |
Pattern | craft_ui_widgets::table::metadata |
A key and value table in groups: a search field over the rows keeps the fields whose name or value matches the typed text, and a check column marks the keys the app shows as columns |
Table<'_, usize> |
Items | craft_ui_widgets::table::view |
A table: one Tab stop, a header row over the columns, the selection rules of the collection contract, type-ahead on the rows' text, rename in place, drag to reorder, and the requests for the app's row and header menus |
DocumentTabs<'_, usize> |
Pattern | craft_ui_widgets::tabs::document |
The tab strip of one document group |
TabStrip<'_, usize> |
Items | craft_ui_widgets::tabs::strip |
A strip of tabs: one Tab stop, arrows move the lead (and the selection with it), a click selects, Enter and a double click activate, Alt+Left and Alt+Right (or a drag) reorder, the menu key asks for the tab's context menu |
Tab<'_> |
Leaf | craft_ui_widgets::tabs::tab |
One tab of a strip |
AltTextField<'_> |
Leaf | craft_ui_widgets::text::alt_text |
An alt text editor: a multi-line description box and a Mark as decorative check |
ChipField<'_> |
Leaf | craft_ui_widgets::text::chips |
A field of removable chips and a draft text part |
LinkedFields<'_, 2> |
Leaf | craft_ui_widgets::text::linked |
N number fields joined by a link toggle |
NumberField<'_> |
Leaf | craft_ui_widgets::text::number |
A number field: a text part over [NumberCodec]; empty text is None |
SelectableText<'_> |
Leaf | craft_ui_widgets::text::selectable_text |
Read-only text the user can focus, select and copy |
TextField<'_> |
Leaf | craft_ui_widgets::text::text_field |
A text field over a codec: plain text by default |
TileGrid<'_, usize> |
Items | craft_ui_widgets::tile_grid::grid |
A grid of tiles: one Tab stop, the selection rules of the collection contract, type-ahead on the tiles' names, rename in place, drag to reorder, files dropped from the OS, and the request for the app's context menu |
ThumbnailSlider<'_> |
Leaf | craft_ui_widgets::tile_grid::slider |
The tile size slider: a small picture glyph button, a Slider over [TileZoom::range] and a large picture glyph button |
Tile<'_> |
Leaf | craft_ui_widgets::tile_grid::tile |
One tile of a tile grid |
AngleDial<'_> |
Leaf | craft_ui_widgets::value_drag::angle_dial |
An angle in degrees: a dial whose needle points where the pointer is |
PointPicker<'_> |
Leaf | craft_ui_widgets::value_drag::point_picker |
A point [x, y] picked on a well: x grows to the right and y downwards, as image coordinates do, in either reading direction |
RangeSlider<'_> |
Leaf | craft_ui_widgets::value_drag::range_slider |
A range slider over range |
Slider<'_> |
Leaf | craft_ui_widgets::value_drag::slider |
A slider over range |
ThumbRow<'_, 4> |
Leaf | craft_ui_widgets::value_drag::thumb_row |
Thumbs on one row, tip up, each a value of its own |
Behaviours
| Module | Purpose |
|---|---|
craft_behavior::anchor |
The nine points of a box, shared by the transform box rules and the reference point picker |
craft_behavior::arrangement |
Arrangement: a custom placement for a body, in logical coordinates |
craft_behavior::codec |
Codec: how a text part turns a value into text and text into a value (18.2), with the library codecs of this crate |
craft_behavior::columns |
Column keys, widths and the sections a grid layout reports |
craft_behavior::command |
The pure rules of command routing (spec 11.3): which state a command resolves to, and which live instance of a scope receives a command fired by a key, the menu bar, the palette or automation |
craft_behavior::cursor |
Cursor requests as plain data and the rule that picks the winner (8.5) |
craft_behavior::divider |
The push-neighbours resize of a row of segments separated by dividers |
craft_behavior::doc_key |
A stable, crate-prefixed semantic key for presence, automation, undo names and programmatic focus |
craft_behavior::edit_history |
EditHistory<T>: the undo and redo of a dialog, a tool session or the keymap editor, fed by edit events |
craft_behavior::editor |
EditorInput: the one ordered input stream the IME engine produces and an editor part reads (18.4) |
craft_behavior::eviction |
When a component's remembered state is due for eviction |
craft_behavior::fit |
The fit rules: which tabs, bar items or titles stay in a strip and which go to an overflow menu |
craft_behavior::flow |
Insets, Flow and Axis: start and end geometry resolved once for the layout direction |
craft_behavior::focus |
Pure focus rules (spec 9.3, 9.4, 8.3): key ownership, focus after removal, the Escape order and the focus-on-press kinds |
craft_behavior::grid |
The Grid cursor: columns resolved from last pass's measurements, and the cell each child takes |
craft_behavior::hit |
Hit shapes, their priority and the arena's resolve rule (8.3) |
craft_behavior::input |
What a component takes from the user, which decides its default key use |
craft_behavior::intent |
Intents: a key, an AccessKit action or typed text turned into meaning (spec 9.2) |
craft_behavior::item_layout |
Item geometry: where each item of a collection sits for a scroll offset and viewport |
craft_behavior::item_marquee |
MarqueeSelect: the rectangle a drag over list items sweeps and the selection it makes (8.7) |
craft_behavior::item_source |
Where a collection's items come from: the data traits and the one way to show a slice |
craft_behavior::keys |
The key table (spec 9.2): the one place that maps a key press to an intent and modifiers to MoveMods |
craft_behavior::label_column |
LabelColumn: label-then-control geometry for one row |
craft_behavior::layout_memory |
The tolerance rule of layout memory: when a measured size asks for a discard pass |
craft_behavior::monitor |
The connected monitors, as every window placement reads them |
craft_behavior::motion |
The motion level an animation runs at |
craft_behavior::nav |
The navigation core (spec 9.5): shapes, the key-free outline, stepping, roving groups, type-ahead and single-value keys |
craft_behavior::one_press |
The one-press-per-pass rule: a pass carries at most one press, as its last pointer event |
craft_behavior::overlay |
place: where an overlay of a given content size goes around its anchor |
craft_behavior::part |
Part keys and part references: the one name for a part in focus, style, results, sub-nodes and decision records |
craft_behavior::pixel_size |
A size in whole pixels |
craft_behavior::placement |
Where windows go on the desktop: where a saved window opens ([place]), which monitor a window is on, and where the next window of a cascade opens |
craft_behavior::press |
Pointer values and the press lifecycle (8.1, 8.2), egui-free: the runtime converts egui's events once per pass and feeds them to a [PressMachine] |
craft_behavior::quantity |
quantity::Reader: the one number and unit parser (18.3): locale digits, unit spellings, expressions and relative input |
craft_behavior::role_rule |
RoleRule: the fields each AccessKit role requires (spec 12.3) |
craft_behavior::scroll |
Scroll positions and the range a scroll part shows |
craft_behavior::selection |
Selection models: what a collection's selection holds and how a change applies to it |
craft_behavior::sense |
The library's sense set, for a root or a part |
craft_behavior::sizing |
Proposal, Metrics and ControlMetrics: what a measure call is asked and what a style gives it to add |
craft_behavior::typing |
TypingRun<C>: the draft, rejected text, commit, cancel, escape rule and limits of a text part (18.2) |
craft_behavior::value |
The value core of chapter 10: the bound every value type meets, Mixed, edit events and the list a pass's events fold into |
craft_behavior::value_drag |
ValueDrag: the drag maths of sliders, dials, scrubbing number fields and rulers, written once (8.7) |
craft_behavior::wheel |
Wheel gesture values, as craft-behavior's copy of egui's types so the wheel split is egui-free |