Struct SliderProps

Source
pub struct SliderProps {
Show 38 fields pub label: &'static str, pub min: f64, pub max: f64, pub step: f64, pub value: Option<f64>, pub range: Option<(f64, f64)>, pub double: bool, pub orientation: Orientation, pub size: Size, pub color: Color, pub cursor_style: Cursor, pub show_value: bool, pub show_steps: bool, pub show_tooltip: bool, pub disabled: bool, pub on_change: Callback<f64>, pub on_change_range: Callback<(f64, f64)>, pub on_focus: Callback<()>, pub on_blur: Callback<()>, pub aria_label: Option<&'static str>, pub aria_describedby: Option<&'static str>, pub container_class: &'static str, pub container_style: &'static str, pub label_class: &'static str, pub label_style: &'static str, pub input_class: &'static str, pub input_style: &'static str, pub output_class: &'static str, pub output_style: &'static str, pub tooltip_style: &'static str, pub steps_style: &'static str, pub slider_width: Width, pub slider_height: Height, pub custom_thumb_css: Option<&'static str>, pub custom_thumb_html: Option<Element>, pub keyboard_step: f64, pub icon_start: Option<Element>, pub icon_end: Option<Element>,
}
Available on crate feature dio only.
Expand description

Props for the Slider component.

These props configure the behavior, appearance, and accessibility of a slider input component supporting both single and double (range) sliders.

ยงFeatures

  • Single or double slider modes.
  • Vertical or horizontal orientation.
  • Customizable appearance with CSS styles and classes.
  • Tooltip, value display, and step indicators.
  • Full accessibility support (ARIA attributes, keyboard steps).

Fieldsยง

ยงlabel: &'static str

Label text displayed above the slider.

ยงmin: f64

Minimum value for the slider.

ยงmax: f64

Maximum value for the slider.

ยงstep: f64

Increment step size.

ยงvalue: Option<f64>

Current value for a single slider mode.

ยงrange: Option<(f64, f64)>

Current range values (start, end) for double slider mode.

ยงdouble: bool

Whether to enable double slider mode (range selector).

ยงorientation: Orientation

Slider orientation: horizontal or vertical.

ยงsize: Size

Size variant for styling the slider track and thumb.

ยงcolor: Color

Color variant for styling the slider.

ยงcursor_style: Cursor

Cursor style when hovering over the slider.

ยงshow_value: bool

Whether to show the current value as an output.

ยงshow_steps: bool

Whether to show step ticks along the slider track.

ยงshow_tooltip: bool

Whether to show tooltip above the thumb on hover.

ยงdisabled: bool

Whether to disable interaction with the slider.

ยงon_change: Callback<f64>

Callback triggered when the slider value changes.

ยงon_change_range: Callback<(f64, f64)>

Callback triggered when the slider range changes (double mode).

ยงon_focus: Callback<()>

Callback triggered when the slider gains focus.

ยงon_blur: Callback<()>

Callback triggered when the slider loses focus.

ยงaria_label: Option<&'static str>

ARIA label for accessibility.

ยงaria_describedby: Option<&'static str>

ARIA describedby attribute for accessibility.

ยงcontainer_class: &'static str

CSS class for the container wrapping the slider.

ยงcontainer_style: &'static str

Inline style for the container wrapping the slider.

ยงlabel_class: &'static str

CSS class for the slider label.

ยงlabel_style: &'static str

Inline style for the slider label.

ยงinput_class: &'static str

CSS class for the slider input element.

ยงinput_style: &'static str

Inline style for the slider input element.

ยงoutput_class: &'static str

CSS class for the value/output display.

ยงoutput_style: &'static str

Inline style for the value/output display.

ยงtooltip_style: &'static str

Inline style for the tooltip element.

ยงsteps_style: &'static str

Inline style for the steps indicator below the slider track.

ยงslider_width: Width

Custom width for the slider track.

ยงslider_height: Height

Custom height for the slider track.

ยงcustom_thumb_css: Option<&'static str>

Optional custom CSS for the slider thumb.

ยงcustom_thumb_html: Option<Element>

Optional custom HTML content for the slider thumb.

ยงkeyboard_step: f64

Keyboard step increment for arrow key adjustments.

ยงicon_start: Option<Element>

Optional icon element displayed before the slider.

ยงicon_end: Option<Element>

Optional icon element displayed after the slider.

Implementationsยง

Sourceยง

impl SliderProps

Source

pub fn builder() -> SliderPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building SliderProps. On the builder, call .label(...)(optional), .min(...)(optional), .max(...)(optional), .step(...)(optional), .value(...)(optional), .range(...)(optional), .double(...)(optional), .orientation(...)(optional), .size(...)(optional), .color(...)(optional), .cursor_style(...)(optional), .show_value(...)(optional), .show_steps(...)(optional), .show_tooltip(...)(optional), .disabled(...)(optional), .on_change(...)(optional), .on_change_range(...)(optional), .on_focus(...)(optional), .on_blur(...)(optional), .aria_label(...)(optional), .aria_describedby(...)(optional), .container_class(...)(optional), .container_style(...)(optional), .label_class(...)(optional), .label_style(...)(optional), .input_class(...)(optional), .input_style(...)(optional), .output_class(...)(optional), .output_style(...)(optional), .tooltip_style(...)(optional), .steps_style(...)(optional), .slider_width(...)(optional), .slider_height(...)(optional), .custom_thumb_css(...)(optional), .custom_thumb_html(...)(optional), .keyboard_step(...)(optional), .icon_start(...)(optional), .icon_end(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SliderProps.

Trait Implementationsยง

Sourceยง

impl Clone for SliderProps

Sourceยง

fn clone(&self) -> SliderProps

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Sourceยง

impl PartialEq for SliderProps

Sourceยง

fn eq(&self, other: &SliderProps) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Sourceยง

impl Properties for SliderProps
where Self: Clone,

Sourceยง

type Builder = SliderPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create โ€œin-progressโ€ versions of the props.
Sourceยง

fn builder() -> Self::Builder

Create a builder for this component.
Sourceยง

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.
Sourceยง

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent
where M: 'static,

Create a component from the props.
Sourceยง

impl StructuralPartialEq for SliderProps

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> InitializeFromFunction<T> for T

Sourceยง

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> IntoPropValue<Option<T>> for T

Sourceยง

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Sourceยง

impl<T> IntoPropValue<T> for T

Sourceยง

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Sourceยง

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Sourceยง

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Sourceยง

fn super_from(input: T) -> O

Convert from a type to another type.
Sourceยง

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Sourceยง

fn super_into(self) -> O

Convert from a type to another type.
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Sourceยง

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,

Sourceยง

impl<T> HasAllProps<(), T> for T