Struct ColorSlider 

pub struct ColorSlider { /* private fields */ }

ColorSlider — adjusts a single channel along a gradient track.

Implementations

impl ColorSlider

pub fn new( id: impl Into<ElementId>, value: PickerColor, channel: ColorChannel, ) -> Self

Creates a slider editing channel of value.

pub fn name(self, name: impl Into<SharedString>) -> Self

name — the name this control submits under.

pub fn form_field(&self) -> Option<FormField>

The Form field this control submits, when it has a name.

v3 discovers a field through the DOM; gpui gives a child no way to reach its ancestor, so the control hands the pair over instead. Borrows, so the control is still yours to place:

let field = control.form_field();
form.field(field.unwrap()).child(control)

pub fn default_value(self, value: PickerColor) -> Self

defaultValue — the uncontrolled initial colour.

Supplying it hands the component its own state: the constructor’s value becomes the seed, and a change moves the component’s copy.

pub fn color_space(self, space: ColorSpace) -> Self

orientation — a vertical slider runs bottom to top. colorSpace — the space the channel is read in. Defaults to HSB, the space PickerColor stores.

pub fn orientation(self, orientation: Orientation) -> Self

Sets the slider orientation (orientation).

pub fn on_change_end( self, handler: impl Fn(&PickerColor, &mut Window, &mut App) + 'static, ) -> Self

onChangeEnd — fires once when the drag finishes.

pub fn length(self, length: impl Into<Pixels>) -> Self

Sets the length of the slider along its axis.

pub fn output( self, render: impl Fn(PickerColor, &str) -> AnyElement + 'static, ) -> Self

ColorSlider.Output’s render function — v3 hands it the color, which is what this closure takes along with the value as v3 formats it.

pub fn thumb( self, render: impl Fn(ColorSliderThumbState) -> AnyElement + 'static, ) -> Self

ColorSlider.Thumb’s render function — the closure receives the shared ColorThumb interaction state while the built-in thumb retains its positioning, focus and drag behavior.

pub fn show_label(self, v: bool) -> Self

Sets whether the label is shown.

pub fn is_disabled(self, v: bool) -> Self

Sets whether the slider is disabled (isDisabled).

pub fn on_change( self, handler: impl Fn(&PickerColor, &mut Window, &mut App) + 'static, ) -> Self

Sets the handler called with the new color as the thumb moves (onChange).

Trait Implementations

impl Disableable for ColorSlider

fn is_disabled(self, disabled: bool) -> Self

isDisabled — whether the component is disabled.

impl IntoElement for ColorSlider

type Element = ViewElement<ColorSlider>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for ColorSlider

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.