Struct ColorPickerState 

pub struct ColorPickerState { /* private fields */ }

State and interaction model for a color picker.

This owns the committed color, the transient preview shown while the user hovers or edits, the controlled open state, the active panel, and the hex field and component sliders that stay in sync with all of them. The application owns the palette, popup, layout, and every visual decision.

Implementations

impl ColorPickerState

pub fn new( window: &mut Window, cx: &mut Context<'_, ColorPickerState>, ) -> ColorPickerState

Creates an empty, closed picker.

pub fn default_value(self, value: impl Into<Hsla>) -> ColorPickerState

Sets the initial committed and previewed color.

pub fn value(&self) -> Option<Hsla>

Returns the committed color.

pub fn preview(&self) -> Option<Hsla>

Returns the color currently being previewed.

pub fn displayed_color(&self) -> Option<Hsla>

Returns the previewed color, falling back to the committed color.

pub fn hex_input(&self) -> &Entity<InputBaseState<InputMode>>

The hex text field. Render it with an application-owned input element.

pub fn sliders(&self) -> &HslaSliders

The HSLA component sliders.

pub fn set_value( &mut self, value: impl Into<Hsla>, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Replaces the committed color without emitting a change.

pub fn clear_value( &mut self, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Clears the committed color without emitting a change.

pub fn sync_pending_value( &mut self, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Applies a value supplied to Self::default_value to the hex field and sliders. Call this from render; it is a no-op once nothing is pending.

pub fn preview_color( &mut self, value: Hsla, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Updates the transient preview color and the hex field that shows it.

pub fn clear_preview( &mut self, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Drops the transient preview, restoring the committed color.

pub fn preview_hex( &mut self, value: &str, _: &mut Window, cx: &mut Context<'_, ColorPickerState>, ) -> bool

Parses a hex color into the transient preview.

Invalid or incomplete input leaves the current preview unchanged. This does not write the hex field, so it is safe to call while typing in it.

pub fn commit_hex( &mut self, value: &str, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, ) -> Option<Hsla>

Parses and commits a hex color, closing the picker on success.

pub fn select_color( &mut self, value: Hsla, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Commits a color and closes the picker, as a palette selection does.

pub fn update_color( &mut self, value: Hsla, window: &mut Window, cx: &mut Context<'_, ColorPickerState>, )

Commits a color without changing the open state, as a slider drag does.

pub fn set_open(&mut self, open: bool, cx: &mut Context<'_, ColorPickerState>)

Sets whether the picker popup is open.

pub fn toggle_open(&mut self, cx: &mut Context<'_, ColorPickerState>)

Toggles the picker popup.

pub fn is_open(&self) -> bool

Returns whether the picker popup is open.

pub fn set_active_tab( &mut self, tab: usize, cx: &mut Context<'_, ColorPickerState>, )

Selects the application-defined picker panel.

pub fn active_tab(&self) -> usize

Returns the selected application-defined picker panel.

Trait Implementations

impl EventEmitter<ColorPickerEvent> for ColorPickerState

impl Focusable for ColorPickerState

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for ColorPickerState

fn render( &mut self, _: &mut Window, _: &mut Context<'_, ColorPickerState>, ) -> impl IntoElement

Render this view into an element tree.