Notifications

GitHub npm crates.io

API Reference

Send native notifications to your user using the notification plugin.

Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

Setup

Install the notifications plugin to get started.

Automatic

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

deno

deno task tauri add notification

bun

bun tauri add notification

cargo

cargo tauri add notification

Manual

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

   cargo add tauri-plugin-notification

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .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

   deno

   bun add npm:@tauri-apps/plugin-notification

   bun

   bun 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';
// when using `"withGlobalTauri": true`, you may use
// const { isPermissionGranted, requestPermission, sendNotification, } = window.__TAURI__.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

tauri::Builder::default()
    .plugin(tauri_plugin_notification::init())
    .setup(|app| {
        use tauri_plugin_notification::NotificationExt;
        app.notification()
            .builder()
            .title("Tauri")
            .body("Tauri is awesome")
            .show()
            .unwrap();

        Ok(())
    })
    .run(tauri::generate_context!())
    .expect("error while running tauri application");

Actions

Actions add interactive buttons and inputs to notifications. Use them to create a responsive experience for your users.

Register Action Types

Register action types to define interactive elements:

import { registerActionTypes } from '@tauri-apps/plugin-notification';

await registerActionTypes([
  {
    id: 'messages',
    actions: [
      {
        id: 'reply',
        title: 'Reply',
        input: true,
        inputButtonTitle: 'Send',
        inputPlaceholder: 'Type your reply...',
      },
      {
        id: 'mark-read',
        title: 'Mark as Read',
        foreground: false,
      },
    ],
  },
]);

Action Properties

Property	Description
id	Unique identifier for the action
title	Display text for the action button
requiresAuthentication	Requires device authentication
foreground	Brings app to foreground when triggered
destructive	Shows action in red on iOS
input	Enables text input
inputButtonTitle	Text for input submit button
inputPlaceholder	Placeholder text for input field

Listen for Actions

Listen to user interactions with notification actions:

import { onAction } from '@tauri-apps/plugin-notification';

await onAction((notification) => {
  console.log('Action performed:', notification);
});

Attachments

Attachments add media content to notifications. Support varies by platform.

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

sendNotification({
  title: 'New Image',
  body: 'Check out this picture',
  attachments: [
    {
      id: 'image-1',
      url: 'asset:///notification-image.jpg',
    },
  ],
});

Attachment Properties

Property	Description
id	Unique identifier
url	Content URL using asset:// or file:// protocol

Note: Test attachments on your target platforms to ensure compatibility.

Channels

Channels organize notifications into categories with different behaviors. While primarily used on Android, they provide a consistent API across platforms.

Create a Channel

import {
  createChannel,
  Importance,
  Visibility,
} from '@tauri-apps/plugin-notification';

await createChannel({
  id: 'messages',
  name: 'Messages',
  description: 'Notifications for new messages',
  importance: Importance.High,
  visibility: Visibility.Private,
  lights: true,
  lightColor: '#ff0000',
  vibration: true,
  sound: 'notification_sound',
});

Channel Properties

Property	Description
id	Unique identifier
name	Display name
description	Purpose description
importance	Priority level (None, Min, Low, Default, High)
visibility	Privacy setting (Secret, Private, Public)
lights	Enable notification LED (Android)
lightColor	LED color (Android)
vibration	Enable vibrations
sound	Custom sound filename

Managing Channels

List existing channels:

import { channels } from '@tauri-apps/plugin-notification';

const existingChannels = await channels();

Remove a channel:

import { removeChannel } from '@tauri-apps/plugin-notification';

await removeChannel('messages');

Using Channels

Send a notification using a channel:

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

sendNotification({
  title: 'New Message',
  body: 'You have a new message',
  channelId: 'messages',
});

Note: Create channels before sending notifications that reference them. Invalid channel IDs prevent notifications from displaying.

Security Considerations

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

Default Permission

This permission set configures which notification features are by default exposed.

Granted Permissions

It allows all notification related features.

• allow-is-permission-granted
• allow-request-permission
• allow-notify
• allow-register-action-types
• allow-register-listener
• allow-cancel
• allow-get-pending
• allow-remove-active
• allow-get-active
• allow-check-permissions
• allow-show
• allow-batch
• allow-list-channels
• allow-delete-channel
• allow-create-channel
• allow-permission-state

Permission Table

Identifier	Description
notification:allow-batch	Enables the batch command without any pre-configured scope.
notification:deny-batch	Denies the batch command without any pre-configured scope.
notification:allow-cancel	Enables the cancel command without any pre-configured scope.
notification:deny-cancel	Denies the cancel command without any pre-configured scope.
notification:allow-check-permissions	Enables the check_permissions command without any pre-configured scope.
notification:deny-check-permissions	Denies the check_permissions command without any pre-configured scope.
notification:allow-create-channel	Enables the create_channel command without any pre-configured scope.
notification:deny-create-channel	Denies the create_channel command without any pre-configured scope.
notification:allow-delete-channel	Enables the delete_channel command without any pre-configured scope.
notification:deny-delete-channel	Denies the delete_channel command without any pre-configured scope.
notification:allow-get-active	Enables the get_active command without any pre-configured scope.
notification:deny-get-active	Denies the get_active command without any pre-configured scope.
notification:allow-get-pending	Enables the get_pending command without any pre-configured scope.
notification:deny-get-pending	Denies the get_pending command without any pre-configured scope.
notification:allow-is-permission-granted	Enables the is_permission_granted command without any pre-configured scope.
notification:deny-is-permission-granted	Denies the is_permission_granted command without any pre-configured scope.
notification:allow-list-channels	Enables the list_channels command without any pre-configured scope.
notification:deny-list-channels	Denies the list_channels command without any pre-configured scope.
notification:allow-notify	Enables the notify command without any pre-configured scope.
notification:deny-notify	Denies the notify command without any pre-configured scope.
notification:allow-permission-state	Enables the permission_state command without any pre-configured scope.
notification:deny-permission-state	Denies the permission_state command without any pre-configured scope.
notification:allow-register-action-types	Enables the register_action_types command without any pre-configured scope.
notification:deny-register-action-types	Denies the register_action_types command without any pre-configured scope.
notification:allow-register-listener	Enables the register_listener command without any pre-configured scope.
notification:deny-register-listener	Denies the register_listener command without any pre-configured scope.
notification:allow-remove-active	Enables the remove_active command without any pre-configured scope.
notification:deny-remove-active	Denies the remove_active command without any pre-configured scope.
notification:allow-request-permission	Enables the request_permission command without any pre-configured scope.
notification:deny-request-permission	Denies the request_permission command without any pre-configured scope.
notification:allow-show	Enables the show command without any pre-configured scope.
notification:deny-show	Denies the show command without any pre-configured scope.