-
Notifications
You must be signed in to change notification settings - Fork 677
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
113 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
--- | ||
title: Notifications | ||
description: Stay tuned while we work on some delicious recipes. | ||
--- | ||
|
||
import { Tabs, TabItem } from '@astrojs/starlight/components'; | ||
|
||
In this recipe we'll take a look at sending a native notification to your user. We'll do this by using the official notification plugin. | ||
|
||
## Setup | ||
|
||
First you have to install the notification plugin in your backend. | ||
|
||
<Tabs> | ||
<TabItem label="Auto"> | ||
```bash | ||
tauri plugin add notification | ||
``` | ||
</TabItem> | ||
<TabItem label="Manual"> | ||
<Tabs> | ||
<TabItem label="Cargo.toml"> | ||
```toml | ||
[dependencies] | ||
tauri-plugin-notification = "2.0.0-alpha" | ||
``` | ||
</TabItem> | ||
<TabItem label="lib.rs"> | ||
```rust | ||
#[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"); | ||
} | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
</TabItem> | ||
</Tabs> | ||
|
||
## Usage | ||
|
||
Once you're done with the general setup you're free to use the notification plugin in either your frontend or straight from the backend. | ||
|
||
### Frontend | ||
|
||
Install the `@tauri-apps/plugin-notification` package using your favorite package manager. | ||
|
||
```js | ||
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!' }); | ||
} | ||
``` | ||
|
||
### Backend | ||
|
||
You can also create notifications straight from the backend. All you need to do is create an instance of `Notification` and `.show()` it. | ||
|
||
<Tabs> | ||
<TabItem label="Command"> | ||
```rust | ||
use tauri_plugin_notification::Notification; | ||
|
||
#[tauri::command] | ||
async fn notify(app: AppHandle) -> Result<(), ()> { | ||
Notification::new(&app.config().tauri.bundle.identifier) | ||
.title("New message") | ||
.body("You've got a new message.") | ||
.show() | ||
} | ||
``` | ||
</TabItem> | ||
<TabItem label="Window event"> | ||
```rust | ||
``` | ||
</TabItem> | ||
<TabItem label="Setup function"> | ||
```rust | ||
``` | ||
</TabItem> | ||
|
||
</Tabs> | ||
|
||
## Deep dive | ||
|
||
### How it works | ||
|
||
The API sends a signal over the IPC to the backend. After that either the `notify-rust` or `win7-notifications` crate | ||
takes care of sending a notification to the users system. | ||
|
||
### Security | ||
|
||
Aside from normal sanitization procedures of user input there are currently no known security notes for this recipe. |
This file was deleted.
Oops, something went wrong.