Struct ColorPicker 

pub struct ColorPicker { /* private fields */ }

Embeddable HSV+RGB+hex+alpha+swatches color picker.

See the module docs for layout options, accessibility, and integration patterns. Use ColorEdit to wrap this in a compact trigger + popover pattern.

use teksilo_core::signal::Signal;
use teksilo_tokens::Color;
use teksilo_widgets::color_picker::{ColorPicker, ColorPickerLayout};

let color = ctx.signal(Color::new(0.42, 0.70, 0.35, 1.0));
let _picker = ColorPicker::new(color)
    .layout(ColorPickerLayout::Compact)
    .alpha_enabled(false);

Implementations

impl ColorPicker

pub fn new(value: Signal<Color>) -> Self

Bind to a non-nullable color signal.

pub fn nullable(value: Signal<Option<Color>>) -> Self

Bind to a nullable color signal. None is treated as transparent black for picker math; any commit produces a concrete Some(color). Apps that want a “clear to None” affordance should expose a separate Clear button alongside the picker.

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

Per-call style override. Higher precedence than the theme-wide style_slots.color_picker slot.

pub fn alpha_enabled(self, e: bool) -> Self

Enable or disable the alpha channel (hue-strip alpha strip + a spinner + hex digit pair).

pub fn show_hsv_canvas(self, s: bool) -> Self

Show or hide the 2D HSV gradient canvas. Hidden in headless or accessibility-only contexts where the pointer-drag surface is not useful.

pub fn show_hue_strip(self, s: bool) -> Self

Show or hide the vertical hue selection strip.

pub fn show_alpha_strip(self, s: bool) -> Self

Show or hide the vertical alpha strip. Defaults to the value of alpha_enabled; call this to decouple them (e.g. show the strip without enabling the alpha spinner).

pub fn show_rgb_spinners(self, s: bool) -> Self

Show or hide the RGB (0–255) component spinners row.

pub fn show_hsv_spinners(self, s: bool) -> Self

Show or hide the HSV (hue 0–359°, saturation 0–100%, value 0–100%) spinners row.

pub fn show_hex_input(self, s: bool) -> Self

Show or hide the hex string input field.

pub fn show_preview(self, s: bool) -> Self

Show or hide the current-color preview swatch (Standard / Wide layouts).

pub fn show_swatches(self, s: bool) -> Self

Show or hide the preset swatch grid (Standard / Wide layouts only).

pub fn show_footer(self, s: bool) -> Self

Show a Done / Cancel footer at the bottom of the picker. Default false for embedded use (the bound signal is the commit channel — there is no “uncommitted” state). Wrappers that present the picker as a popover (e.g. ColorEdit) flip this to true so the user has explicit accept / dismiss affordances; the buttons fire Self::on_done / Self::on_cancel respectively.

pub fn on_done(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Callback fired when the user activates the footer’s Done button. The picker has already been writing through to the bound signal as the user dragged / typed, so Done’s job is purely to dismiss the surrounding surface (popover, sheet, dialog). Only meaningful when show_footer(true).

pub fn on_cancel(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Callback fired when the user activates the footer’s Cancel button. The picker itself does not restore any value — that’s the caller’s responsibility (e.g. ColorEdit captures a snapshot at popover-open time and writes it back here). The callback’s typical implementation is value.set(snapshot.get()); ctx.dismiss_self_overlay_chain();. Only meaningful when show_footer(true).

pub fn swatches(self, s: impl Into<Prop<Vec<Color>>>) -> Self

Replace the default 12-color DEFAULT_SWATCHES with a custom palette — statically, or reactively via a bound Signal<Vec<Color>> that updates live without rebuilding the picker.

pub fn swatch_columns(self, n: usize) -> Self

Number of columns in the preset swatch grid. Defaults to 6; clamped to at least 1.

pub fn layout(self, l: ColorPickerLayout) -> Self

Select the overall layout variant. Defaults to ColorPickerLayout::Standard.

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

Set the accessible group label for the picker root node. Defaults to the localized “Color picker” string.

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 tooltip(self, text: impl Into<LocalizedString>) -> Self

Attach a plain single-line tooltip shown after a hover delay.

Mutually exclusive with Self::rich_tooltip, Self::rich_tooltip_content, and Self::composite_tooltip — the last setter called wins.

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

Attach a rich tooltip looked up from the registry by key.

Mutually exclusive with the other tooltip setters — the last call wins.

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

Attach an inline rich tooltip from an already-constructed crate::tooltip::TooltipContent.

Mutually exclusive with the other tooltip setters — the last call wins.

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

Attach a composite tooltip whose body is an arbitrary widget tree.

Mutually exclusive with the other tooltip setters — the last call wins.

pub fn current(&self) -> Color

Read the current bound color. Convenience for tests / apps that hold a ColorPicker reference; otherwise prefer reading the Signal<Color> you passed in.

Trait Implementations

impl Debug for ColorPicker

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

Formats the value using the given formatter.

impl Widget for ColorPicker

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 children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

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

Declare this widget’s accessibility identity.

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).