Skip to main content

Crate sui_widgets

Crate sui_widgets 

Source

Re-exports§

pub use animation::AnimationBindingInvalidation;
pub use animation::MotionScalar;
pub use animation::Progress;
pub use animation::TimelineBindingSink;
pub use animation::TimelinePlayer;
pub use animation::TimelineTick;
pub use animation::invalidation_for_animation_property;
pub use canvas::Canvas;
pub use canvas::CanvasColors;
pub use canvas::CanvasGridStyle;
pub use canvas::CanvasRuler;
pub use canvas::CanvasRulerAxis;
pub use canvas::CanvasRulerColors;
pub use canvas::CanvasShape;
pub use canvas::CanvasStroke;
pub use canvas::CanvasSurface;
pub use canvas::CanvasViewport;
pub use canvas::CanvasZoomBehavior;
pub use canvas::CanvasZoomContext;
pub use canvas::PixelCanvas;
pub use canvas::PixelCanvasBlendMode;
pub use canvas::PixelCanvasBrushShape;
pub use canvas::PixelCanvasColors;
pub use canvas::PixelCanvasExportSnapshot;
pub use canvas::PixelCanvasState;
pub use canvas::PixelCanvasTool;
pub use canvas::paint_canvas_grid;
pub use collection::CollectionAnchor;
pub use collection::CollectionAnchorGravity;
pub use collection::CollectionChange;
pub use collection::CollectionDelta;
pub use collection::CollectionExtentIndex;
pub use collection::CollectionModelError;
pub use collection::CollectionSync;
pub use collection::CollectionWindow;
pub use collection::ScrollAlignment;
pub use collection::VirtualCollectionModel;
pub use collection::VirtualCollectionSource;
pub use collection::VirtualList;
pub use collection::VirtualListChrome;
pub use collection::VirtualListSelectionMode;
pub use collection::VirtualListState;
pub use collection::VirtualViewportSnapshot;
pub use composites::ActionCard;
pub use composites::ActionTileGeometry;
pub use composites::ActionTilePaint;
pub use composites::BottomSheet;
pub use composites::BrowserTabBar;
pub use composites::CalloutPaint;
pub use composites::CodePanelPaint;
pub use composites::CodeTextLine;
pub use composites::CodeTextPaint;
pub use composites::CodeTextSpan;
pub use composites::CommandButtonFill;
pub use composites::CommandButtonPaint;
pub use composites::CommandGroup;
pub use composites::CommandPalette;
pub use composites::ContextMenu;
pub use composites::ContextMenuHandle;
pub use composites::CoverageDots;
pub use composites::CoverageDotsConfig;
pub use composites::DetailRow;
pub use composites::Dialog;
pub use composites::DisclosureButtonPaint;
pub use composites::DockPanel;
pub use composites::EmptyState;
pub use composites::EmptyStatePaint;
pub use composites::FieldGroup;
pub use composites::FormRow;
pub use composites::FormSection;
pub use composites::FramedField;
pub use composites::HairlineEdge;
pub use composites::Menu;
pub use composites::MenuItem;
pub use composites::PanelSection;
pub use composites::PlacementBadge;
pub use composites::PlacementBadgePaint;
pub use composites::Popover;
pub use composites::PopoverAlignment;
pub use composites::PresetStrip;
pub use composites::ProgressBar;
pub use composites::PropertyRow;
pub use composites::PropertyRowLayout;
pub use composites::SectionLabel;
pub use composites::SectionLabelPaint;
pub use composites::SectionPanelGeometry;
pub use composites::SectionPanelPaint;
pub use composites::SegmentedControl;
pub use composites::SegmentedControlItem;
pub use composites::ShadowBox;
pub use composites::SheetState;
pub use composites::SideSheet;
pub use composites::SideSheetPlacement;
pub use composites::Spinner;
pub use composites::StatusBadge;
pub use composites::StatusBar;
pub use composites::StatusBarHost;
pub use composites::StatusBarSegment;
pub use composites::Surface;
pub use composites::SurfaceAppearance;
pub use composites::SurfaceBorder;
pub use composites::SurfaceElevation;
pub use composites::SurfaceRole;
pub use composites::TabBar;
pub use composites::TabBarItem;
pub use composites::Tabs;
pub use composites::ToolPalette;
pub use composites::ToolPaletteItem;
pub use composites::Toolbar;
pub use composites::Tooltip;
pub use composites::TooltipAlignment;
pub use composites::TooltipPlacement;
pub use composites::detail_row_height_for_value;
pub use composites::paint_action_tile;
pub use composites::paint_border;
pub use composites::paint_callout;
pub use composites::paint_code_lines;
pub use composites::paint_code_panel;
pub use composites::paint_command_button;
pub use composites::paint_coverage_dots;
pub use composites::paint_coverage_dots_with_config;
pub use composites::paint_detail_row_at;
pub use composites::paint_disclosure_button;
pub use composites::paint_empty_state;
pub use composites::paint_hairline;
pub use composites::paint_placement_badge;
pub use composites::paint_placement_badge_with;
pub use composites::paint_progress_bar;
pub use composites::paint_rounded_panel;
pub use composites::paint_rounded_rect;
pub use composites::paint_section_label;
pub use composites::paint_section_label_detail;
pub use composites::paint_section_panel;
pub use composites::paint_status_badge;
pub use containers::Align;
pub use containers::Background;
pub use containers::ContentExtent;
pub use containers::Dock;
pub use containers::FixedPaneSplit;
pub use containers::Flex;
pub use containers::MeasuredBottomDock;
pub use containers::Overflow;
pub use containers::Padding;
pub use containers::RebuildOnChange;
pub use containers::RebuildOnConstraints;
pub use containers::ScrollAxes;
pub use containers::ScrollBar;
pub use containers::ScrollState;
pub use containers::ScrollView;
pub use containers::SemanticRegion;
pub use containers::SizedBox;
pub use containers::Stack;
pub use containers::SwitchView;
pub use containers::TrailingSlotRow;
pub use containers::VirtualScrollView;
pub use controls::BUILTIN_ICON_GLYPHS;
pub use controls::Button;
pub use controls::ButtonAppearance;
pub use controls::Checkbox;
pub use controls::CheckboxIndicatorState;
pub use controls::ChoiceAppearance;
pub use controls::DateTimeInput;
pub use controls::FieldAppearance;
pub use controls::Icon;
pub use controls::IconButton;
pub use controls::IconButtonPaint;
pub use controls::IconGlyph;
pub use controls::InteractionPreview;
pub use controls::Label;
pub use controls::NumberInput;
pub use controls::PasswordInput;
pub use controls::RadioButton;
pub use controls::RadioGroup;
pub use controls::Select;
pub use controls::Separator;
pub use controls::Slider;
pub use controls::Switch;
pub use controls::TextArea;
pub use controls::TextInput;
pub use controls::draw_glyph;
pub use controls::paint_checkbox_indicator;
pub use controls::paint_icon_button;
pub use data::Breadcrumb;
pub use data::BreadcrumbItem;
pub use data::LayerList;
pub use data::LayerListItem;
pub use data::LayerListReorderChange;
pub use data::LeadingLabelCellPaint;
pub use data::ListItem;
pub use data::ListView;
pub use data::Table;
pub use data::TableColumn;
pub use data::TableColumnAlignment;
pub use data::TableRow;
pub use data::TextBlockPaint;
pub use data::TextCellPaint;
pub use data::TreeItem;
pub use data::TreeView;
pub use data::VirtualTable;
pub use data::VirtualTableColumn;
pub use data::VirtualTableRowActivationKind;
pub use data::VirtualTableRowContext;
pub use data::VirtualTableSortDirection;
pub use data::VirtualTableState;
pub use data::paint_leading_label_cell;
pub use data::paint_text_block;
pub use data::paint_text_cell;
pub use docking::DockCloseAction;
pub use docking::DockFloatingGroup;
pub use docking::DockLayoutError;
pub use docking::DockNode;
pub use docking::DockPanelId;
pub use docking::DockPanelOptions;
pub use docking::DockPlacement;
pub use docking::DockWorkspace;
pub use docking::DockWorkspaceSnapshot;
pub use docking::DockWorkspaceState;
pub use docking::DockZone;
pub use drag_drop::DragDropHost;
pub use drag_drop::Draggable;
pub use drag_drop::DropHover;
pub use drag_drop::DropTarget;
pub use hdr_theme::EffectToken;
pub use hdr_theme::HdrColorRoles;
pub use hdr_theme::HdrEffectTokens;
pub use hdr_theme::HdrLuminanceTokens;
pub use hdr_theme::HdrMaterialTokens;
pub use hdr_theme::HdrPolicyTokens;
pub use hdr_theme::HdrThemeMode;
pub use hdr_theme::HdrThemeTokens;
pub use hdr_theme::MaterialToken;
pub use hdr_theme::ResolvedEffectStyle;
pub use hdr_theme::ResolvedHdrStyle;
pub use hdr_theme::ResolvedMaterialStyle;
pub use hdr_theme::SemanticColorToken;
pub use hdr_theme::WidgetColorRole;
pub use hdr_theme::WidgetEffectRole;
pub use hdr_theme::WidgetLuminanceRole;
pub use hdr_theme::WidgetMaterialRole;
pub use hdr_theme::resolve_effect_role;
pub use hdr_theme::resolve_luminance_role;
pub use hdr_theme::resolve_material_role;
pub use hdr_theme::resolve_semantic_color;
pub use hdr_theme::resolve_widget_hdr_style;
pub use layout_policy::AspectRatio;
pub use layout_policy::AspectRatioFit;
pub use layout_policy::Grid;
pub use layout_policy::GridCell;
pub use layout_policy::LayoutTransition;
pub use layout_policy::SafeArea;
pub use layout_policy::SafeAreaEdges;
pub use media::BrushPreview;
pub use media::BrushPreviewShape;
pub use media::BrushPreviewSpec;
pub use media::ColorPalette;
pub use media::ColorPaletteSwatch;
pub use media::ColorPicker;
pub use media::ColorPickerColors;
pub use media::ColorSwatch;
pub use media::Image;
pub use media::ImageFit;
pub use media::SignalMeter;
pub use media::SimpleColorPicker;
pub use media::SimpleColorPickerMode;
pub use overlay::NotificationCenter;
pub use overlay::NotificationHost;
pub use overlay::NotificationId;
pub use overlay::NotificationUrgency;
pub use overlay::OverlayAlignment;
pub use overlay::OverlayCollisionPolicy;
pub use overlay::OverlayHost;
pub use overlay::OverlayPlacement;
pub use overlay::OverlayPlacementRequest;
pub use overlay::OverlayPlacementResult;
pub use overlay::OverlaySide;
pub use overlay::TransientNotification;
pub use overlay::place_overlay;
pub use panes::FloatingStack;
pub use panes::FloatingViewConfig;
pub use panes::FloatingViewSnapshot;
pub use panes::FloatingWorkspace;
pub use panes::FloatingWorkspaceState;
pub use panes::SplitExtent;
pub use panes::SplitPaneSide;
pub use panes::SplitState;
pub use panes::SplitStateSnapshot;
pub use panes::SplitView;
pub use presence::KeyedStack;
pub use presence::Presence;
pub use presence::PresenceTransition;
pub use reorderable::ReorderableList;
pub use reorderable::ReorderableListChange;
pub use rich_document::BasicSyntaxHighlighter;
pub use rich_document::RichAttachment;
pub use rich_document::RichBlockId;
pub use rich_document::RichDocumentBlock;
pub use rich_document::RichDocumentBlockKind;
pub use rich_document::RichDocumentModel;
pub use rich_document::RichDocumentRenderContext;
pub use rich_document::RichDocumentRendererRegistry;
pub use rich_document::RichDocumentSnapshot;
pub use rich_document::RichDocumentSpan;
pub use rich_document::RichDocumentStatus;
pub use rich_document::RichDocumentUpdate;
pub use rich_document::RichDocumentView;
pub use rich_document::RichDocumentViewState;
pub use rich_document::RichExtensionBlock;
pub use rich_document::RichInlineImage;
pub use rich_document::RichInlineKind;
pub use rich_document::RichInlineStyle;
pub use rich_document::RichListItem;
pub use rich_document::RichSyntaxHighlighter;
pub use rich_document::RichSyntaxSpan;
pub use rich_document::RichSyntaxTokenKind;
pub use rich_text::RichText;
pub use rich_text::RichTextSourceMap;
pub use rich_text::RichTextSourceSpan;
pub use selection::SelectionChange;
pub use selection::SelectionClipboardBehavior;
pub use selection::SelectionEntry;
pub use selection::SelectionIntent;
pub use selection::SelectionOrder;
pub use selection::SelectionOwnerId;
pub use selection::SelectionPayload;
pub use selection::SelectionPoint;
pub use selection::SelectionScope;
pub use selection::TextSelectionInfo;
pub use text_command::TEXT_COMMAND;
pub use text_command::TextCommand;
pub use text_surface::TextSurface;
pub use text_surface::TextSurfaceOverlayKind;
pub use text_surface::TextSurfaceStatus;
pub use text_surface::TextSurfaceStyleOverlay;
pub use text_surface::TextSurfaceStyleSpan;
pub use theme::ControlMetrics;
pub use theme::ControlPalette;
pub use theme::ControlSize;
pub use theme::ControlStateMetrics;
pub use theme::ControlTypography;
pub use theme::DecorativeColors;
pub use theme::DecorativeHue;
pub use theme::DecorativePalette;
pub use theme::DefaultTheme;
pub use theme::GlowTone;
pub use theme::NeutralRamp;
pub use theme::SemanticTone;
pub use theme::SurfacePalette;
pub use theme::ThemeAspectRatios;
pub use theme::ThemeBlurScale;
pub use theme::ThemeBoxShadowScale;
pub use theme::ThemeBreakpoints;
pub use theme::ThemeColorScheme;
pub use theme::ThemeColors;
pub use theme::ThemeContainers;
pub use theme::ThemeDensity;
pub use theme::ThemeDropShadowScale;
pub use theme::ThemeFontFamilies;
pub use theme::ThemeFontStack;
pub use theme::ThemeFontWeights;
pub use theme::ThemeGlows;
pub use theme::ThemeInsetShadowScale;
pub use theme::ThemeLeading;
pub use theme::ThemeMotion;
pub use theme::ThemePerspective;
pub use theme::ThemeRadii;
pub use theme::ThemeShadow;
pub use theme::ThemeShadowLayer;
pub use theme::ThemeShadows;
pub use theme::ThemeTextScale;
pub use theme::ThemeTextShadowScale;
pub use theme::ThemeTextToken;
pub use theme::ThemeTracking;
pub use theme::ToneRoles;
pub use theme::paint_theme_glow;
pub use theme::paint_theme_inset_shadow;
pub use theme::paint_theme_shadow;
pub use workspace::AdaptiveBreakpoints;
pub use workspace::AdaptiveClass;
pub use workspace::AdaptiveView;
pub use workspace::ConstraintOrientation;
pub use workspace::ConstraintQuery;
pub use workspace::ConstraintView;
pub use workspace::MasterDetail;
pub use workspace::MasterDetailRoute;
pub use workspace::MasterDetailState;
pub use workspace::ResponsiveSidebar;
pub use workspace::ResponsiveSidebarMode;
pub use workspace::ResponsiveSidebarSnapshot;
pub use workspace::ResponsiveSidebarState;

Modules§

animation
canvas
collection
composites
Public exports for the feature modules below.
containers
controls
data
docking
Retained, same-window docking workspace for editor-style applications.
drag_drop
hdr_theme
layout_policy
media
overlay
panes
presence
Content that animates in and out.
reorderable
rich_document
rich_text
selection
text_command
text_surface
theme
workspace

Structs§

AnimatedValue
A value animated by elapsed time: call AnimatedValue::tick with each frame’s delta. Retargeting keeps momentum like MotionValue.
AnimationBinding
AnimationDocument
AnimationDocumentFormatError
AnimationEditorState
AnimationPlayer
AnimationPropertyPath
AnimationSelection
AnimationTargetId
AnimationTick
Blink
Clip
CompiledClip
CompiledTimeline
CompiledTrack
ElidedLine
One line of text fitted to a width, ending in “…” when it is cut.
Keyframe
KeyframeSelection
MotionValue
A value that animates toward its latest target on an absolute clock.
Paragraph
Text wrapped to a width and laid out once, to measure and then paint.
PlaybackSpan
A stretch of timeline the playhead moved over in one tick.
PlaybackState
Pulse
SampleBatch
SampleBuffer
SampledAnimationValue
SpringF32
A spring that follows a moving target, stepped by elapsed time. Use it for physics-driven motion, such as a dragged handle that springs home carrying the velocity of the fling; for transitions between states prefer MotionValue with an AnimationSpec::Spring.
SpringSpec
A spring described the way designers tune one: how long it takes to settle, and how much it bounces.
Stagger
Delays that start a group of animations one after another, such as list items cascading in.
TextPlacement
Where text goes in the rect it is painted into.
Timeline
TimelineMarker
A named point in time on a timeline. Players report the markers the playhead passes, so an app can start the next step of a sequence or play a sound in time with the animation.
TimelineSnap
Track
Transition

Enums§

AnimationEditorCommand
AnimationProperty
AnimationSpec
How a value travels to a new target: a timed curve or a spring.
AnimationValue
AnimationValueKind
Easing
LoopMode
StaggerOrigin
Where a Stagger starts: the item that animates first.
TextOverflow
What a widget does with a label too wide for its space.
VerticalAlign
Where text goes vertically in the rect it is painted into.

Constants§

ANIMATION_DOCUMENT_VERSION
MIN_ANIMATION_DOCUMENT_VERSION
The oldest document version this build still reads. Version 2 added timeline markers.

Traits§

Interpolate
TextShaper
Lays text out: implemented by the measure and paint contexts, and by LayoutContext.

Functions§

paint_text
Paint text in rect, wrapped to its width and placed by placement.
paint_text_line
Paint text on one line in rect, never wrapping: centered vertically on its capital letters and placed horizontally by align.
paint_text_line_elided
Paint text on one line in rect as paint_text_line does, fitted to the rect’s width as an ElidedLine: cut text ends in “…” rather than in a glyph cut in half.
wrap_text_lines
Paint one unwrapped line using SUI’s shared optical baseline alignment path. Greedy word-wrap text to max_width, using measure for run widths.

Type Aliases§

SharedCompiledTimeline