Notifications

GitHub npm crates.io

API Reference

Send native notifications to your user using the notification plugin.

Setup

Install the notifications plugin to get started.

Automatic

1. Use your project’s package manager to add the dependency:

npm

npm run tauri add notification

Yarn

yarn run tauri add notification

pnpm

pnpm tauri add notification

Cargo

cargo tauri add notification

2. Modify lib.rs to initialize the plugin:

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        // Initialize the plugin
        .plugin(tauri_plugin_notification::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Manual

1. Run cargo add tauri-plugin-notification to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

lib.rs

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        // Initialize the plugin
        .plugin(tauri_plugin_notification::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

3. If you’d like to use notifications in JavaScript then install the npm package as well:

npm

npm install @tauri-apps/plugin-notification

Yarn

yarn add @tauri-apps/plugin-notification

pnpm

pnpm add @tauri-apps/plugin-notification

Usage

Here are a few examples of how to use the notification plugin:

• Send notification to users
• Add an action to a notification
• Add an attachment to a notification
• Send a notification in a specific channel

The notification plugin is available in both JavaScript and Rust.

Send Notification

Follow these steps to send a notification:

1. Check if permission is granted
2. Request permission if not granted
3. Send the notification

JavaScript

import {
  isPermissionGranted,
  requestPermission,
  sendNotification,
} from '@tauri-apps/plugin-notification';

// Do you have permission to send a notification?
let permissionGranted = await isPermissionGranted();

// If not we need to request it
if (!permissionGranted) {
  const permission = await requestPermission();
  permissionGranted = permission === 'granted';
}

// Once permission has been granted we can send the notification
if (permissionGranted) {
  sendNotification({ title: 'Tauri', body: 'Tauri is awesome!' });
}

Rust

Contribute

This is a stub and is waiting for contributions. Get involved by visiting us on GitHub or joining us on Discord.

Actions

Contribute

This is a stub and is waiting for contributions. Get involved by visiting us on GitHub or joining us on Discord.

Attachments

Contribute

This is a stub and is waiting for contributions. Get involved by visiting us on GitHub or joining us on Discord.

Channels

Contribute

This is a stub and is waiting for contributions. Get involved by visiting us on GitHub or joining us on Discord.

Security Considerations

Aside from normal sanitization procedures of user input there are currently no known security considerations.