From 1adf7e3872f2c8cb8d04eb558255505821223c13 Mon Sep 17 00:00:00 2001 From: sadao komaki <8beeeaaat@gmail.com> Date: Mon, 22 Jul 2024 20:17:22 +0900 Subject: [PATCH] docs(notification): Add capability instructions and usage example (#1569) --- plugins/notification/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/plugins/notification/README.md b/plugins/notification/README.md index 8d1f9637..9e3a5075 100644 --- a/plugins/notification/README.md +++ b/plugins/notification/README.md @@ -57,10 +57,40 @@ fn main() { } ``` +Then you need to add the permissions to your capabilities file: + +`src-tauri/capabilities/main.json` + +```json +{ + ... + "permissions": [ + ... + "notification:default" + ], + ... +} +``` + + Afterwards all the plugin's APIs are available through the JavaScript guest bindings: ```javascript +import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification'; +async function checkPermission() { + if (!(await isPermissionGranted())) { + return (await requestPermission()) === 'granted'; + } + return true; +} + +export async function enqueueNotification(title, body) { + if (!(await checkPermission())) { + return; + } + sendNotification({ title, body }); +} ``` ## Contributing