Struct SplitButton 

pub struct SplitButton { /* private fields */ }

A button split into a default-action region and a chevron dropdown region.

See the module-level documentation for a usage overview.

Implementations

impl SplitButton

pub fn new() -> Self

Standard SplitButton: picking an item from the dropdown both fires the item’s action and promotes it to become the new default for the session. The main region’s label and click action update to match the most recently picked item.

pub fn new_static() -> Self

Static-default SplitButton: the main region is pinned to initial_selected (default 0) and never changes after the user picks something from the dropdown. Picking an item still fires that item’s action — only the promotion is skipped.

Use this when the main region represents a semantically fixed primary action (e.g. “Commit”) and the dropdown offers related variants (“Commit and Push”, “Commit and Push to…”) that should not displace the primary.

pub fn item(self, item: MenuItem) -> Self

Add a menu item. The item is reused verbatim as a row of the dropdown, and its label + action are also used to drive the main region (when its index is the current default).

pub fn separator(self) -> Self

Add a separator row in the dropdown. Separators are skipped when computing item indices for initial_selected.

pub fn variant(self, variant: ButtonVariant) -> Self

Set the visual style variant (filled, plain, ghost, …) for the entire button frame. Mirrors the same variants as Button::variant.

pub fn icon(self, icon: IconWidget) -> Self

Set a leading icon for the main (default-action) region, rendered before the label (mirrors Button::icon with IconLocation::Leading). Unlike the per-row MenuItem::icons, this glyph is fixed regardless of which item is the current default — use it for a stable action affordance (e.g. a “＋” add glyph).

The icon’s tint follows the main-region label (the variant/interaction cascade, or text_role when overridden), so any colour set on the passed IconWidget is replaced — same contract as Button. Its size is left alone, so .icon_size(..) on the caller’s widget is honoured.

pub fn style(self, style: impl SplitButtonStyle) -> Self

Override the Tier-3 frame chrome for this instance. Takes precedence over theme.style_slots.split_button and the built-in RecipeSplitButtonStyle.

pub fn text_style(self, style: impl Into<TextStyleProp>) -> Self

Override the main-region label text style (font, size, weight). Accepts a TextStyleRole, a TextStyle, or a Signal of either. Default (unset) is the inner TextWidget default — e.g. pass TextStyleRole::BodyBold for a bold default action.

pub fn text_role(self, color: impl Into<ColorProp>) -> Self

Override the control’s text colour — the main-region label, its leading icon, and the chevron, which the variant/interaction cascade tints together. Accepts Color, a role, or a Signal of either. Default (unset) is that cascade; setting this replaces it wholesale (loses hover/disabled tint).

pub fn enabled(self, enabled: impl Into<Prop<bool>>) -> Self

Set the enabled state, statically or reactively. Forwarded to the arena at build time.

pub fn initial_selected(self, index: usize) -> Self

Which item index (counting only items, not separators) should be the initial default. Defaults to 0.

pub fn tooltip(self, text: impl Into<LocalizedString>) -> Self

Attach a tooltip to the main (default-action) region. Same hover delay as Button::tooltip.

pub fn rich_tooltip(self, key: impl Into<String>) -> Self

Attach a rich tooltip to the main region.

pub fn rich_tooltip_content(self, content: TooltipContent) -> Self

Attach a rich tooltip to the main region driven by inline TooltipContent.

pub fn composite_tooltip(self, content: impl Widget + 'static) -> Self

Attach a composite tooltip to the main region.

pub fn chevron_tooltip(self, text: impl Into<LocalizedString>) -> Self

Override the tooltip shown on hover over the trailing chevron region. When unset, the chevron gets a default “Show dropdown menu” tooltip so its affordance isn’t silent.

pub fn chevron_rich_tooltip(self, key: impl Into<String>) -> Self

Attach a rich tooltip to the chevron region.

pub fn chevron_rich_tooltip_content(self, content: TooltipContent) -> Self

Attach a rich tooltip to the chevron region driven by inline TooltipContent.

pub fn chevron_composite_tooltip(self, content: impl Widget + 'static) -> Self

Attach a composite tooltip to the chevron region.

Trait Implementations

impl Debug for SplitButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SplitButton

fn default() -> Self

Returns the “default value” for a type.

impl Widget for SplitButton

fn build(&mut self, ctx: &mut BuildContext<'_>) -> Vec<WidgetId>

Compose child widgets. Called once after the widget is placed in the arena, and again on environment change (theme switch, locale switch). Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

fn layout_response( &self, proposal: SizeProposal, ctx: &LayoutContext<'_>, ) -> LayoutResponse

Respond to the parent’s size proposal with this widget’s wanted size, grow/shrink weights, and compression floor (see [LayoutResponse]).

fn place_children( &self, bounds: Rect, _proposal: SizeProposal, children: &mut [WidgetPlacement], _ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

fn accessibility(&self, builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

fn children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

fn type_name(&self) -> &'static str

Concrete type name of this widget (e.g. "teksilo_widgets::button::Button"). The default implementation resolves at the impl site via std::any::type_name::<Self>(), so calls through &dyn Widget correctly dispatch to the monomorphized fn for the concrete type — getting the concrete name through the vtable without per-impl boilerplate.

fn cacheable_layout(&self) -> bool

Whether this widget’s layout_response may be memoized by the per-pass layout cache. Defaults to true.

fn paint(&self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

fn wants_after_paint(&self) -> bool

Whether this widget wants its after_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t aggregate descendant geometry.

fn after_paint(&self, _view: &WidgetTreeView<'_>, _ctx: &PaintContext<'_>)

Called once per frame after this widget’s subtree has finished painting. Receives a read-only view of the layout-resolved arena so a parent can read its descendants’ final bounds — e.g. TitleBar aggregates its drag region and control-button rects into a single HitRegions payload for the Windows backend’s WM_NCHITTEST.

fn wants_post_paint(&self) -> bool

Whether this widget wants its post_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t draw a foreground over their children.

fn post_paint( &self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>, )

Draw a foreground layer over this widget’s children.

fn wants_descendant_redirects(&self) -> bool

Whether this widget wants the AT walker to consult its a11y_redirect_descendant hook for every descendant during AT tree emission, not just its direct arena children.

fn a11y_redirect_descendant( &self, _self_id: WidgetId, _descendant: WidgetId, ) -> Option<NodeId>

Optional redirection hook for AT-tree placement of a child.

fn accessible_title_hint(&self) -> Option<String>

Suggest an accessible title to an enclosing container that wraps this widget as content — typically a modal / dialog shell that wants to propagate the inner content’s visible title as the shell’s own accessible name.

fn initial_focus_hint(&self) -> Option<WidgetId>

Optional hint that directs initial focus to a specific descendant when this widget is the root of a deferred-built modal surface.

fn accessibility_children(&self) -> Option<Vec<WidgetId>>

Optional override for the child ORDER presented to assistive technology, when it must differ from the paint / z-order child order returned by children.

fn as_any(&self) -> Option<&(dyn Any + 'static)>

Downcast hook. Default implementation returns None; concrete widgets override with Some(self) when they want to expose their concrete type to test-level introspection or reflection. The trait already bounds on std::any::Any so concrete types satisfy the 'static requirement.

fn as_any_mut(&mut self) -> Option<&mut (dyn Any + 'static)>

Mutable counterpart of as_any. Default returns None; widgets that want to expose mutable state to tests (e.g. so a test can mutate a Scene inside a SceneView post-layout) override with Some(self). Should follow the same opt-in pattern as as_any: only widgets that opt into & introspection should opt into &mut.

fn clips_children(&self) -> bool

Whether this widget clips its children to its bounds.

fn focus_reveal_rect(&self, _bounds: Rect) -> Option<Rect>

The rectangle (in absolute tree coordinates) that best represents this widget when the framework reveals it into an ancestor scroll area on focus gain. Returning None (the default) reveals the widget’s whole bounds — correct for most controls.

fn hit_shape(&self, _local_point: Point, _bounds: Rect) -> bool

Whether the point lies inside this widget’s actual shape, not just its rectangular bounds. Consulted by hit-testing right after the bounds check: returning false for a point that is inside the bounding box makes the widget transparent to the click there, so it falls through to whatever sibling is painted underneath (the same machinery as a fully pass-through node, but shape-aware).

fn preserves_children_on_rebuild(&self) -> bool

How rebuild_single_widget treats this widget’s existing children when re-running its build().

fn tooltip_has_content(&self) -> bool

Whether this widget, used as tooltip content, currently has anything worth showing.

fn declare_shortcuts(&self) -> Vec<Shortcut>

Declare the rebindable keyboard shortcuts this widget exposes, without installing handlers. The framework calls this at arena insertion time (before build()) and at certain lazy boundaries (e.g. Switcher walks declarations on its not-yet-mounted Pending slots), so settings UIs and the ShortcutRegistry see the keystrokes the moment the owning container mounts — even if build() hasn’t run.

fn take_handler_set(&mut self) -> Option<HandlerSet>

Extract attached handler set from a WidgetWithHandlers wrapper. Called during arena insertion to transfer handlers to the WidgetNode. Default: returns None (no attached handlers).