Skip to main content

Slider

Struct Slider 

Source
pub struct Slider { /* private fields */ }
Expand description

A reactive slider.

You can set the slider to a percent value between 0 and 100.

The slider is composed of four parts: the main view, the background bar, an accent bar, and a handle. The background bar is separate from the main view because it is shortened when EdgeAlign is set to false.

Responding to events: You can respond to slider changes by listening to SliderChanged events:

slider::Slider::new(|| 40.pct())
    .on_event(SliderChanged::listener(), |cx, state| {
        println!("Value: {}", state.value);
        println!("Percent: {:?}", state.pct);
        println!("Pixels: {}", state.px);
        EventPropagation::Continue
    });

You can also listen to SliderHover events to respond when the user hovers over the slider:

slider::Slider::new(|| 40.pct())
    .on_event(SliderHover::listener(), |cx, state| {
        println!("Hovering at: {:?}", state.pct);
        EventPropagation::Continue
    });

These events are only fired on user interaction (mouse events or arrow keys), not on reactive updates.

You can also disable event handling with Decorators::disabled. This is useful if you want to use the slider as a progress bar.

Styling: You can use the Slider::slider_style method to get access to a SliderCustomStyle which has convenient functions with documentation for styling all of the properties of the slider.

Styling Example:

slider::Slider::new(|| 40.pct())
    .slider_style(|s| {
        s.edge_align(true)
            .handle_radius(50.pct())
            .bar_color(palette::css::BLACK)
            .bar_radius(100.pct())
            .accent_bar_color(palette::css::GREEN)
            .accent_bar_radius(100.pct())
            .accent_bar_height(100.pct())
    });

Implementations§

Source§

impl Slider

Source

pub fn new<P>(percent: impl Fn() -> P + 'static) -> Slider
where P: Into<Pct>,

Create a new reactive slider.

Listen to slider changes using the SliderChanged event:

§Example
let percent = RwSignal::new(40.pct());

slider::Slider::new(move || percent.get())
    .on_event(SliderChanged::listener(), move |cx, event| {
        percent.set(event.pct);
        EventPropagation::Continue
    })
    .slider_style(|s| {
        s.handle_radius(0)
            .bar_radius(25.pct())
            .accent_bar_radius(25.pct())
    })
    .style(|s| s.width(200));
Source

pub fn new_rw( percent: impl SignalGet<Pct> + SignalUpdate<Pct> + Copy + 'static, ) -> Slider

Create a new reactive slider.

This automatically hooks up the event logic and keeps the signal up to date.

If you need more control over the getting and setting of the value you will want to use Slider::new which gives you more control but does not automatically keep a signal up to date.

§Example
let percent = RwSignal::new(40.pct());

slider::Slider::new_rw(percent)
    .slider_style(|s| {
        s.handle_radius(0)
            .bar_radius(25.pct())
            .accent_bar_radius(25.pct())
    })
    .style(|s| s.width(200));
Source

pub fn new_ranged( value: impl Fn() -> f64 + 'static, range: RangeInclusive<f64>, ) -> Slider

Create a new reactive, ranged slider.

Listen to value changes using the SliderChanged event and read event.state.value.

§Example
let value = RwSignal::new(-25.0);
let range = -50.0..=100.0;

slider::Slider::new_ranged(move || value.get(), range)
    .step(5.0)
    .on_event(SliderChanged::listener(), move |cx, event| {
        value.set(event.value);
        EventPropagation::Continue
    })
    .slider_style(|s| {
        s.handle_radius(0)
            .bar_radius(25.pct())
            .accent_bar_radius(25.pct())
    })
    .style(|s| s.width(200));
Source

pub fn slider_style( self, style: impl Fn(SliderCustomStyle) -> SliderCustomStyle + 'static, ) -> Slider

Sets the custom style properties of the Slider.

Source

pub fn step(self, step: f64) -> Slider

Sets the step spacing of the Slider.

Trait Implementations§

Source§

impl CustomStylable<SliderCustomStyle> for Slider

Source§

type DV = Slider

The view type that this custom stylable converts to.
Source§

fn custom_style(self, style: impl Fn(S) -> S + 'static) -> Self::DV

Applies custom styling to the view with access to specialized custom style methods. Read more
Source§

impl View for Slider

Source§

fn id(&self) -> ViewId

Source§

fn update(&mut self, _cx: &mut UpdateCx<'_>, state: Box<dyn Any>)

Use this method to react to changes in view-related state. You will usually send state to this hook manually using the View’s Id handle Read more
Source§

fn event(&mut self, cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the target and bubble phases of event propagation. Read more
Source§

fn style_pass(&mut self, cx: &mut StyleCx<'_>)

Use this method to style the view’s children. Read more
Source§

fn paint(&mut self, cx: &mut PaintCx<'_>)

View-specific implementation. Called during paint traversal for this view. Children are painted automatically by Floem. Views should only paint their own content (backgrounds, borders, custom drawing).
Source§

fn view_style(&self) -> Option<Style>

Source§

fn view_class(&self) -> Option<StyleClassRef>

Source§

fn debug_name(&self) -> Cow<'static, str>

Source§

fn event_capture(&mut self, _cx: &mut EventCx<'_>) -> EventPropagation

Handles an event during the capture phase of event propagation. Read more
Source§

fn post_paint(&mut self, cx: &mut PaintCx<'_>)

Auto Trait Implementations§

§

impl Freeze for Slider

§

impl !RefUnwindSafe for Slider

§

impl !Send for Slider

§

impl !Sync for Slider

§

impl Unpin for Slider

§

impl UnsafeUnpin for Slider

§

impl !UnwindSafe for Slider

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> ButtonExt for T
where T: IntoView + 'static,

Source§

fn button(self) -> Button

Create a Button from the parent.
Source§

impl<T> ClipExt for T
where T: IntoView + 'static,

Source§

fn clip(self) -> Clip

Wrap the view in a clip view.
Source§

impl<T> ContainerExt for T
where T: IntoView + 'static,

Source§

fn container(self) -> Container

Wrap the view in a container.
Source§

impl<T> Decorators for T
where T: IntoView,

Source§

fn style(self, style: impl Fn(Style) -> Style + 'static) -> Self::Intermediate

Alter the style of the view. Read more
Source§

fn debug_name(self, name: impl Into<String>) -> Self::Intermediate

Add a debug name to the view that will be shown in the inspector. Read more
Source§

fn debug_name_if<S>( self, apply: impl Fn() -> bool + 'static, name: impl Fn() -> S + 'static, ) -> Self::Intermediate
where S: Into<String>,

Conditionally add a debug name to the view that will be shown in the inspector. Read more
Source§

fn dragging_style( self, style: impl Fn(Style) -> Style + 'static, ) -> Self::Intermediate

The visual style to apply when the view is being dragged
Source§

fn class<C>(self, _class: C) -> Self::Intermediate
where C: StyleClass,

Add a style class to the view
Source§

fn class_if<C>( self, apply: impl Fn() -> bool + 'static, _class: C, ) -> Self::Intermediate
where C: StyleClass,

Conditionally add a style class to the view
Source§

fn remove_class<C>(self, _class: C) -> Self::Intermediate
where C: StyleClass,

Remove a style class from the view
Source§

fn keyboard_navigable(self) -> Self::Intermediate

👎Deprecated:

Set this property using Style::keyboard_navigable instead

Allows the element to be navigated to with the keyboard. Similar to setting tabindex=“0” in html.
Source§

fn disable_default_event<L>( self, disable: impl Fn() -> (L, bool) + 'static, ) -> Self::Intermediate

Dynamically controls whether the default view behavior for an event should be disabled. When disable is true, children will still see the event, but the view event function will not be called nor the event listeners on the view. Read more
Source§

fn draggable(self) -> <Self::Intermediate as IntoView>::Intermediate

Mark the current view as draggable with default configuration. Read more
Source§

fn draggable_with_config( self, config: impl Fn() -> DragConfig + 'static, ) -> <Self::Intermediate as IntoView>::Intermediate

Mark the current view as draggable with custom configuration. Read more
Source§

fn disabled( self, disabled_fn: impl Fn() -> bool + 'static, ) -> Self::Intermediate

👎Deprecated:

use Style::set_disabled directly instead

Mark the view as disabled Read more
Source§

fn on_event_with_config<L>( self, listener: L, config: EventCallbackConfig, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) -> EventPropagation + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener with custom phase configuration.
Source§

fn on_event_cont_with_config<L>( self, listener: L, config: EventCallbackConfig, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener. This event will be handled with the given handler and the event will continue propagating.
Source§

fn on_event_stop_with_config<L>( self, listener: L, config: EventCallbackConfig, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener. This event will be handled with the given handler and the event will stop propagating.
Source§

fn on_event<L>( self, listener: L, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) -> EventPropagation + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener.
Source§

fn on_event_cont<L>( self, listener: L, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener. This event will be handled with the given handler and the event will continue propagating.
Source§

fn on_event_stop<L>( self, listener: L, action: impl FnMut(&mut EventCx<'_>, &<L as EventListenerTrait>::EventData) + 'static, ) -> Self::Intermediate

Add an event handler for the given EventListener. This event will be handled with the given handler and the event will stop propagating.
Source§

fn on_key_down( self, key: Key, cmp: impl Fn(Modifiers) -> bool + 'static, action: impl FnMut(&mut EventCx<'_>, &KeyboardEvent) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event(listener::KeyDown, ...) instead.

Add a handler for pressing down a specific key.
Source§

fn on_key_up( self, key: Key, cmp: impl Fn(Modifiers) -> bool + 'static, action: impl FnMut(&mut EventCx<'_>, &KeyboardEvent) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event(listener::KeyUp, ...) instead.

Add a handler for a specific key being released.
Source§

fn on_click( self, action: impl FnMut(&mut EventCx<'_>) -> EventPropagation + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event(Click, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::Click.
Source§

fn on_click_cont( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_cont(Click, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::Click. This event will be handled with the given handler and the event will continue propagating.
Source§

fn on_click_stop( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_stop(Click, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::Click. This event will be handled with the given handler and the event will stop propagating.
Source§

fn action(self, action: impl FnMut() + 'static) -> Self::Intermediate

Attach action executed on button click or Enter or Space Key.
Source§

fn on_double_click( self, action: impl FnMut(&mut EventCx<'_>) -> EventPropagation + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event(DoubleClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::DoubleClick
Source§

fn on_double_click_cont( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_cont(DoubleClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::DoubleClick. This event will be handled with the given handler and the event will continue propagating.
Source§

fn on_double_click_stop( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_stop(DoubleClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::DoubleClick. This event will be handled with the given handler and the event will stop propagating.
Source§

fn on_secondary_click( self, action: impl FnMut(&mut EventCx<'_>) -> EventPropagation + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event(SecondaryClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::SecondaryClick. This is most often the “Right” click.
Source§

fn on_secondary_click_cont( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_cont(SecondaryClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::SecondaryClick. This is most often the “Right” click. This event will be handled with the given handler and the event will continue propagating.
Source§

fn on_secondary_click_stop( self, action: impl FnMut(&mut EventCx<'_>) + 'static, ) -> Self::Intermediate

👎Deprecated:

Use on_event_stop(SecondaryClick, |cx, _event| { ... }) instead. The new API provides direct access to typed event data.

Add an event handler for EventListener::SecondaryClick. This is most often the “Right” click. This event will be handled with the given handler and the event will stop propagating.
Source§

fn on_cleanup(self, action: impl Fn() + 'static) -> Self::Intermediate

Adds an event handler for cleanup events for this view. Read more
Source§

fn animation( self, animation: impl Fn(Animation) -> Animation + 'static, ) -> Self::Intermediate

Add an animation to the view. Read more
Source§

fn clear_focus(self, when: impl Fn() + 'static) -> Self::Intermediate

Clear the focus from the window. Read more
Source§

fn request_focus(self, when: impl Fn() + 'static) -> Self::Intermediate

Request that this view gets the focus for the window. Read more
Source§

fn window_scale( self, scale_fn: impl Fn() -> f64 + 'static, ) -> Self::Intermediate

Set the window scale factor. Read more
Source§

fn window_title( self, title_fn: impl Fn() -> String + 'static, ) -> Self::Intermediate

Set the window title. Read more
Source§

fn window_menu( self, menu_fn: impl Fn() -> MenuBuilder<Menu> + 'static, ) -> Self::Intermediate

Set the system window menu Read more
Source§

fn context_menu( self, menu: impl Fn() -> MenuBuilder<Menu> + 'static, ) -> Self::Intermediate

Adds a secondary-click context menu to the view, which opens at the mouse position. Read more
Source§

fn popout_menu( self, menu: impl Fn() -> MenuBuilder<Menu> + 'static, ) -> Self::Intermediate

Adds a primary-click context menu, which opens below the view. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<V> HasViewId for V
where V: View,

Source§

fn view_id(&self) -> ViewId

Returns the ViewId associated with this value.
§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<VW> IntoView for VW
where VW: View + 'static,

Source§

type V = VW

The final View type this converts to.
Source§

type Intermediate = VW

Intermediate type that has a ViewId before full view construction. Read more
Source§

fn into_intermediate(self) -> <VW as IntoView>::Intermediate

Converts to the intermediate form which has a ViewId. Read more
Source§

fn into_view(self) -> <VW as IntoView>::V

Converts the value into a View.
Source§

fn into_any(self) -> Box<dyn View>

Converts the value into a AnyView.
Source§

impl<T> OverlayExt for T
where T: IntoView + 'static,

Source§

fn overlay(self) -> Overlay

Wrap the view in an overlay.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ScrollExt for T
where T: IntoView + 'static,

Source§

fn scroll(self) -> Scroll

Wrap the view in a scroll view.
Source§

impl<T> TooltipExt for T
where T: IntoView + 'static,

Source§

fn tooltip<V>(self, tip: impl Fn() -> V + 'static) -> Tooltip
where V: IntoView + 'static,

Adds a tooltip to the view. 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more