Add cancel event (#4476)

* feat: add cancel event

* feat: provide cancel event

* feat: insert cancel event in web

* fix: typo

* feat: propagate implementation of cancel event

* fix merge conflicts / tests

---------

Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
This commit is contained in:
Damien CORLERandJonathan Kelley authored and GitHub committed 2025-08-20 11:09:24 -07:00
1 parent f95d8e4682
commit 8d617080b1
9 files changed
+165 -5

No files matched your search

+88
View File
@@ -0,0 +1,88 @@
use dioxus_core::Event;
pub type CancelEvent = Event<CancelData>;
pub struct CancelData {
inner: Box<dyn HasCancelData>,
}
impl<E: HasCancelData> From<E> for CancelData {
fn from(e: E) -> Self {
Self { inner: Box::new(e) }
}
}
impl std::fmt::Debug for CancelData {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("CancelData").finish()
}
}
impl PartialEq for CancelData {
fn eq(&self, _other: &Self) -> bool {
true
}
}
impl CancelData {
/// Create a new CancelData
pub fn new(inner: impl HasCancelData + 'static) -> Self {
Self {
inner: Box::new(inner),
}
}
/// Downcast this event to a concrete event type
#[inline(always)]
pub fn downcast<T: 'static>(&self) -> Option<&T> {
self.inner.as_any().downcast_ref::<T>()
}
}
#[cfg(feature = "serialize")]
/// A serialized version of CancelData
#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
pub struct SerializedCancelData {}
#[cfg(feature = "serialize")]
impl From<&CancelData> for SerializedCancelData {
fn from(_: &CancelData) -> Self {
Self {}
}
}
#[cfg(feature = "serialize")]
impl HasCancelData for SerializedCancelData {
fn as_any(&self) -> &dyn std::any::Any {
self
}
}
#[cfg(feature = "serialize")]
impl serde::Serialize for CancelData {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
SerializedCancelData::from(self).serialize(serializer)
}
}
#[cfg(feature = "serialize")]
impl<'de> serde::Deserialize<'de> for CancelData {
fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
let data = SerializedCancelData::deserialize(deserializer)?;
Ok(Self {
inner: Box::new(data),
})
}
}
pub trait HasCancelData: std::any::Any {
/// return self as Any
fn as_any(&self) -> &dyn std::any::Any;
}
impl_event! {
CancelData;
/// oncancel
oncancel
}
+10
View File
@@ -115,6 +115,8 @@ impl PlatformEventData {
pub trait HtmlEventConverter: Send + Sync {
/// Convert a general event to an animation data event
fn convert_animation_data(&self, event: &PlatformEventData) -> AnimationData;
/// Convert a general event to a cancel data event
fn convert_cancel_data(&self, event: &PlatformEventData) -> CancelData;
/// Convert a general event to a clipboard data event
fn convert_clipboard_data(&self, event: &PlatformEventData) -> ClipboardData;
/// Convert a general event to a composition data event
@@ -161,6 +163,12 @@ impl From<&PlatformEventData> for AnimationData {
}
}
impl From<&PlatformEventData> for CancelData {
fn from(val: &PlatformEventData) -> Self {
with_event_converter(|c| c.convert_cancel_data(val))
}
}
impl From<&PlatformEventData> for ClipboardData {
fn from(val: &PlatformEventData) -> Self {
with_event_converter(|c| c.convert_clipboard_data(val))
@@ -276,6 +284,7 @@ impl From<&PlatformEventData> for WheelData {
}
mod animation;
mod cancel;
mod clipboard;
mod composition;
mod drag;
@@ -297,6 +306,7 @@ mod visible;
mod wheel;
pub use animation::*;
pub use cancel::*;
pub use clipboard::*;
pub use composition::*;
pub use drag::*;