adam/leptos-use
1
0
Fork 0
mirror of https://github.com/adoyle0/leptos-use.git synced 2025-01-23 09:09:21 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #142 from hcandelaria/use_web_notification

Browse source 
Feat: Enhance `UseWebNotificationOptions` and `ShowOptions` with additional fields
This commit is contained in:
Marc-Stefan Cassola 2024-08-01 16:08:38 +01:00 • committed by GitHub
commit 8d8169861c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 55 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/use_web_notification/src/main.rs
View file

@ -14,7 +14,7 @@ fn Demo() -> impl IntoView {
.title("Hello World from leptos-use") .title("Hello World from leptos-use")
.direction(NotificationDirection::Auto) .direction(NotificationDirection::Auto)
.language("en") .language("en")
// .renotify(true) .renotify(true)
.tag("test"), .tag("test"),
); );

71
src/use_web_notification.rs
View file

@ -28,6 +28,7 @@ use std::rc::Rc;
/// UseWebNotificationOptions::default() /// UseWebNotificationOptions::default()
/// .direction(NotificationDirection::Auto) /// .direction(NotificationDirection::Auto)
/// .language("en") /// .language("en")
/// .renotify(true)
/// .tag("test"), /// .tag("test"),
/// ); /// );
/// ///
@ -227,10 +228,7 @@ impl From<NotificationDirection> for web_sys::NotificationDirection {
/// See [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/API/notification) for more info. /// See [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/API/notification) for more info.
/// ///
/// The following implementations are missing: /// The following implementations are missing:
/// - `renotify`
/// - `vibrate` /// - `vibrate`
/// - `silent`
/// - `image`
#[derive(DefaultBuilder, Clone)] #[derive(DefaultBuilder, Clone)]
#[cfg_attr(feature = "ssr", allow(dead_code))] #[cfg_attr(feature = "ssr", allow(dead_code))]
pub struct UseWebNotificationOptions { pub struct UseWebNotificationOptions {
@ -264,14 +262,25 @@ pub struct UseWebNotificationOptions {
#[builder(into)] #[builder(into)]
icon: Option<String>, icon: Option<String>,
/// The URL of the image to be displayed as part of the notification as specified
/// in the constructor's options parameter.
#[builder(into)]
image: Option<String>,
/// A boolean value indicating that a notification should remain active until the /// A boolean value indicating that a notification should remain active until the
/// user clicks or dismisses it, rather than closing automatically. /// user clicks or dismisses it, rather than closing automatically.
require_interaction: bool, require_interaction: bool,
// /// A boolean value specifying whether the user should be notified after a new notification replaces an old one. /// A boolean value specifying whether the user should be notified after a new notification replaces an old one.
// /// The default is `false`, which means they won't be notified. If `true`, then `tag` also must be set. /// The default is `false`, which means they won't be notified. If `true`, then `tag` also must be set.
// #[builder(into)] #[builder(into)]
// renotify: bool, renotify: bool,
/// A boolean value specifying whether the notification should be silent, regardless of the device settings.
/// The default is `false`, which means the notification is not silent. If `true`, then the notification will be silent.
#[builder(into)]
silent: Option<bool>,
/// Called when the user clicks on displayed `Notification`. /// Called when the user clicks on displayed `Notification`.
on_click: Rc<dyn Fn(web_sys::Event)>, on_click: Rc<dyn Fn(web_sys::Event)>,
@ -295,8 +304,10 @@ impl Default for UseWebNotificationOptions {
language: None, language: None,
tag: None, tag: None,
icon: None, icon: None,
image: None,
require_interaction: false, require_interaction: false,
// renotify: false, renotify: false,
silent: None,
on_click: Rc::new(|_| {}), on_click: Rc::new(|_| {}),
on_close: Rc::new(|_| {}), on_close: Rc::new(|_| {}),
on_error: Rc::new(|_| {}), on_error: Rc::new(|_| {}),
@ -311,8 +322,9 @@ impl From<&UseWebNotificationOptions> for web_sys::NotificationOptions {
web_sys_options web_sys_options
.dir(options.direction.into()) .dir(options.direction.into())
.require_interaction(options.require_interaction); .require_interaction(options.require_interaction)
// .renotify(options.renotify); .renotify(options.renotify)
.silent(options.silent);
if let Some(body) = &options.body { if let Some(body) = &options.body {
web_sys_options.body(body); web_sys_options.body(body);
@ -322,6 +334,10 @@ impl From<&UseWebNotificationOptions> for web_sys::NotificationOptions {
web_sys_options.icon(icon); web_sys_options.icon(icon);
} }
if let Some(image) = &options.image {
web_sys_options.image(image);
}
if let Some(language) = &options.language { if let Some(language) = &options.language {
web_sys_options.lang(language); web_sys_options.lang(language);
} }
@ -340,8 +356,6 @@ impl From<&UseWebNotificationOptions> for web_sys::NotificationOptions {
/// ///
/// The following implementations are missing: /// The following implementations are missing:
/// - `vibrate` /// - `vibrate`
/// - `silent`
/// - `image`
#[derive(DefaultBuilder, Default)] #[derive(DefaultBuilder, Default)]
#[cfg_attr(feature = "ssr", allow(dead_code))] #[cfg_attr(feature = "ssr", allow(dead_code))]
pub struct ShowOptions { pub struct ShowOptions {
@ -376,14 +390,25 @@ pub struct ShowOptions {
#[builder(into)] #[builder(into)]
icon: Option<String>, icon: Option<String>,
/// The URL of the image to be displayed as part of the notification as specified
/// in the constructor's options parameter.
#[builder(into)]
image: Option<String>,
/// A boolean value indicating that a notification should remain active until the /// A boolean value indicating that a notification should remain active until the
/// user clicks or dismisses it, rather than closing automatically. /// user clicks or dismisses it, rather than closing automatically.
#[builder(into)] #[builder(into)]
require_interaction: Option<bool>, require_interaction: Option<bool>,
// /// A boolean value specifying whether the user should be notified after a new notification replaces an old one.
// /// The default is `false`, which means they won't be notified. If `true`, then `tag` also must be set. /// A boolean value specifying whether the user should be notified after a new notification replaces an old one.
// #[builder(into)] /// The default is `false`, which means they won't be notified. If `true`, then `tag` also must be set.
// renotify: Option<bool>, #[builder(into)]
renotify: Option<bool>,
/// A boolean value specifying whether the notification should be silent, regardless of the device settings.
/// The default is `false`, which means the notification is not silent. If `true`, then the notification will be silent.
#[builder(into)]
silent: Option<bool>,
} }
#[cfg(not(feature = "ssr"))] #[cfg(not(feature = "ssr"))]
@ -405,6 +430,10 @@ impl ShowOptions {
options.icon(icon); options.icon(icon);
} }
if let Some(image) = &self.image {
options.image(image);
}
if let Some(language) = &self.language { if let Some(language) = &self.language {
options.lang(language); options.lang(language);
} }
@ -413,9 +442,13 @@ impl ShowOptions {
options.tag(tag); options.tag(tag);
} }
// if let Some(renotify) = &self.renotify { if let Some(renotify) = self.renotify {
// options.renotify(renotify); options.renotify(renotify);
// } }
if let Some(silent) = self.silent {
options.silent(Some(silent));
}
} }
} }