Skip to main content

Hover

Struct Hover 

Source
pub struct Hover {
    pub on_start: Option<Rc<RefCell<dyn FnMut(())>>>,
    pub on_end: Option<Rc<RefCell<dyn FnMut(())>>>,
    pub on_cancel: Option<Rc<RefCell<dyn FnMut(())>>>,
    pub on_pointer_appear: Option<Rc<RefCell<dyn FnMut(HoverPointerAppearData)>>>,
    pub on_pointer_update: Option<Rc<RefCell<dyn FnMut(HoverPointerUpdateData)>>>,
    pub on_pointer_disappear: Option<Rc<RefCell<dyn FnMut(HoverPointerDisappearData)>>>,
    pub on_pointer_cancel: Option<Rc<RefCell<dyn FnMut(HoverPointerCancelData)>>>,
}
Expand description
use dioxus::prelude::*;
use dioxus_gestures::{
    state::gestures::hover::Hover,
    use_gestures::{use_gestures, Gestures},
};

const UNHOVERED_TEXT: &str = "Hover over me!";
const HOVERED_TEXT: &str = "Hovering ...";

#[component]
pub fn HoverExample() -> Element {
    let mut text = use_signal(|| UNHOVERED_TEXT);

    let gestures = use_gestures(
        Gestures::default().hover(
            Hover::default()
                .on_start(move |_| text.set(HOVERED_TEXT))
                .on_end(move |_| text.set(UNHOVERED_TEXT))
                .on_cancel(move |_| text.set(UNHOVERED_TEXT)),
        ),
    );

    rsx! {
        div {
        class: "target hover",
        style: format!("
            user-select: none;
            touch-action: none;
            position: relative;
        "),
        ..gestures.event_handlers(),
            "{text}"
        }
    }
}

Fields§

§on_start: Option<Rc<RefCell<dyn FnMut(())>>>§on_end: Option<Rc<RefCell<dyn FnMut(())>>>§on_cancel: Option<Rc<RefCell<dyn FnMut(())>>>§on_pointer_appear: Option<Rc<RefCell<dyn FnMut(HoverPointerAppearData)>>>§on_pointer_update: Option<Rc<RefCell<dyn FnMut(HoverPointerUpdateData)>>>§on_pointer_disappear: Option<Rc<RefCell<dyn FnMut(HoverPointerDisappearData)>>>§on_pointer_cancel: Option<Rc<RefCell<dyn FnMut(HoverPointerCancelData)>>>

Implementations§

Source§

impl Hover

Source

pub fn on_start(self, handler: impl FnMut(()) + 'static) -> Self

Source

pub fn on_end(self, handler: impl FnMut(()) + 'static) -> Self

Source

pub fn on_cancel(self, handler: impl FnMut(()) + 'static) -> Self

Source

pub fn on_pointer_appear( self, handler: impl FnMut(HoverPointerAppearData) + 'static, ) -> Self

Source

pub fn on_pointer_update( self, handler: impl FnMut(HoverPointerUpdateData) + 'static, ) -> Self

Source

pub fn on_pointer_disappear( self, handler: impl FnMut(HoverPointerDisappearData) + 'static, ) -> Self

Source

pub fn on_pointer_cancel( self, handler: impl FnMut(HoverPointerCancelData) + 'static, ) -> Self

Trait Implementations§

Source§

impl Clone for Hover

Source§

fn clone(&self) -> Hover

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Hover

Source§

fn default() -> Hover

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Hover

§

impl !Send for Hover

§

impl !Sync for Hover

§

impl !UnwindSafe for Hover

§

impl Freeze for Hover

§

impl Unpin for Hover

§

impl UnsafeUnpin for Hover

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