@choochmeque/tauri-plugin-notifications-api 0.3.4 → 0.4.0

package/README.md

@@ -45,7 +45,7 @@ Add the plugin to your Tauri project's `Cargo.toml`:
 
 ```toml
 [dependencies]
-tauri-plugin-notifications = "0.3"
+tauri-plugin-notifications = "0.4"
 ```
 
 ### Push Notifications Feature
@@ -68,6 +68,33 @@ Without this feature enabled:
 - Push notification registration code is disabled
 - The `registerForPushNotifications()` function will return an error if called
 
+### Desktop Notification Backend (notify-rust)
+
+The `notify-rust` feature is **enabled by default** and provides cross-platform desktop notifications using the [notify-rust](https://crates.io/crates/notify-rust) crate.
+
+**When to use notify-rust (default):**
+- Simple notifications on Linux, macOS, and Windows
+- Cross-platform consistency
+- Basic notification features (title, body, icon)
+
+**When to disable notify-rust:**
+- You need native Windows toast notifications with advanced features (actions, hero images, scheduling)
+- You want platform-specific notification features on macOS/Windows
+
+To disable `notify-rust` and use native platform implementations:
+
+```toml
+[dependencies]
+tauri-plugin-notifications = { version = "0.3", default-features = false }
+```
+
+To disable `notify-rust` and enable push notifications:
+
+```toml
+[dependencies]
+tauri-plugin-notifications = { version = "0.3", default-features = false, features = ["push-notifications"] }
+```
+
 Configure the plugin permissions in your `capabilities/default.json`:
 
 ```json
@@ -89,6 +116,24 @@ fn main() {
 }
 ```
 
+## Example App
+
+An example app is available in [`examples/notifications-demo`](examples/notifications-demo) demonstrating all plugin features:
+
+- Permission management and push notifications (mobile)
+- Basic, scheduled, and styled notifications
+- Interactive notifications with action buttons
+- Notification channels (Android)
+- Pending and active notification management
+- Event listeners with logging
+
+**Run it:**
+```bash
+cd examples/notifications-demo
+pnpm install
+pnpm tauri dev
+```
+
 ## Usage
 
 ### JavaScript/TypeScript

package/dist-js/index.cjs

@@ -248,7 +248,7 @@ async function cancel(notifications) {
  * @returns A promise indicating the success or failure of the operation.
  */
 async function cancelAll() {
-    await core.invoke("plugin:notifications|cancel");
+    await core.invoke("plugin:notifications|cancel_all");
 }
 /**
  * Retrieves the list of active notifications.
@@ -311,7 +311,7 @@ async function removeAllActive() {
  * @returns A promise indicating the success or failure of the operation.
  */
 async function createChannel(channel) {
-    await core.invoke("plugin:notifications|create_channel", { ...channel });
+    await core.invoke("plugin:notifications|create_channel", { channel });
 }
 /**
  * Removes the channel with the given identifier.
@@ -339,7 +339,7 @@ async function removeChannel(id) {
  * @returns A promise resolving to the list of notification channels.
  */
 async function channels() {
-    return await core.invoke("plugin:notifications|listChannels");
+    return await core.invoke("plugin:notifications|list_channels");
 }
 /**
  * Registers a listener for incoming notifications.

package/dist-js/index.js

@@ -246,7 +246,7 @@ async function cancel(notifications) {
  * @returns A promise indicating the success or failure of the operation.
  */
 async function cancelAll() {
-    await invoke("plugin:notifications|cancel");
+    await invoke("plugin:notifications|cancel_all");
 }
 /**
  * Retrieves the list of active notifications.
@@ -309,7 +309,7 @@ async function removeAllActive() {
  * @returns A promise indicating the success or failure of the operation.
  */
 async function createChannel(channel) {
-    await invoke("plugin:notifications|create_channel", { ...channel });
+    await invoke("plugin:notifications|create_channel", { channel });
 }
 /**
  * Removes the channel with the given identifier.
@@ -337,7 +337,7 @@ async function removeChannel(id) {
  * @returns A promise resolving to the list of notification channels.
  */
 async function channels() {
-    return await invoke("plugin:notifications|listChannels");
+    return await invoke("plugin:notifications|list_channels");
 }
 /**
  * Registers a listener for incoming notifications.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choochmeque/tauri-plugin-notifications-api",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "license": "MIT",
   "author": "You",
   "description": "A Tauri v2 plugin for sending notifications on desktop and mobile platforms with support for system notifications and push delivery via FCM and APNs.",