Struct leptos_use::UseWebNotificationOptions

pub struct UseWebNotificationOptions { /* private fields */ }

Options for use_web_notification_with_options. See MDN Docs for more info.

The following implementations are missing:

• vibrate

Implementations

impl UseWebNotificationOptions

pub fn title(self, value: impl Into<String>) -> Self

The title property of the Notification interface indicates the title of the notification

pub fn body<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

The body string of the notification as specified in the constructor’s options parameter.

pub fn direction(self, value: NotificationDirection) -> Self

The text direction of the notification as specified in the constructor’s options parameter. Can be LeftToRight, RightToLeft or Auto (default). See web_sys::NotificationDirection for more info.

pub fn language<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

The language code of the notification as specified in the constructor’s options parameter.

pub fn tag<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

The ID of the notification(if any) as specified in the constructor’s options parameter.

pub fn icon<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

The URL of the image used as an icon of the notification as specified in the constructor’s options parameter.

pub fn image<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

The URL of the image to be displayed as part of the notification as specified in the constructor’s options parameter.

pub fn require_interaction(self, value: bool) -> Self

A boolean value indicating that a notification should remain active until the user clicks or dismisses it, rather than closing automatically.

pub fn renotify(self, value: impl Into<bool>) -> Self

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.

pub fn silent<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<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.

pub fn on_click(self, value: impl Fn(Event) + 'static) -> Self

Called when the user clicks on displayed Notification.

pub fn on_close(self, value: impl Fn(Event) + 'static) -> Self

Called when the user closes a Notification.

pub fn on_error(self, value: impl Fn(Event) + 'static) -> Self

Called when something goes wrong with a Notification (in many cases an error preventing the notification from being displayed.)

pub fn on_show(self, value: impl Fn(Event) + 'static) -> Self

Called when a Notification is displayed

Trait Implementations

impl Clone for UseWebNotificationOptions

fn clone(&self) -> UseWebNotificationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for UseWebNotificationOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&UseWebNotificationOptions> for NotificationOptions

fn from(options: &UseWebNotificationOptions) -> Self

Converts to this type from the input type.