Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leanflutter/local_notifier
This plugin allows Flutter desktop apps to notify local notifications.
https://github.com/leanflutter/local_notifier
flutter-desktop local-notification
Last synced: 12 days ago
JSON representation
This plugin allows Flutter desktop apps to notify local notifications.
- Host: GitHub
- URL: https://github.com/leanflutter/local_notifier
- Owner: leanflutter
- License: mit
- Created: 2021-09-07T23:44:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-22T01:17:13.000Z (6 months ago)
- Last Synced: 2024-12-14T19:06:44.297Z (19 days ago)
- Topics: flutter-desktop, local-notification
- Language: C++
- Homepage:
- Size: 225 KB
- Stars: 74
- Watchers: 3
- Forks: 32
- Open Issues: 13
-
Metadata Files:
- Readme: README-ZH.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-flutter-desktop - local_notifier - This plugin allows Flutter desktop apps to displaying local notifications. (Packages)
README
# local_notifier
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url] ![][visits-count-image]
[pub-image]: https://img.shields.io/pub/v/local_notifier.svg
[pub-url]: https://pub.dev/packages/local_notifier
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
[discord-url]: https://discord.gg/zPa6EZ2jqb
[visits-count-image]: https://img.shields.io/badge/dynamic/json?label=Visits%20Count&query=value&url=https://api.countapi.xyz/hit/leanflutter.local_notifier/visits
这个插件允许 Flutter 桌面 应用显示本地通知。
---
[English](./README.md) | 简体中文
---
- [local_notifier](#local_notifier)
- [平台支持](#平台支持)
- [截图](#截图)
- [快速开始](#快速开始)
- [安装](#安装)
- [Linux requirements](#linux-requirements)
- [用法](#用法)
- [谁在用使用它？](#谁在用使用它)
- [相关链接](#相关链接)
- [许可证](#许可证)
## 平台支持
| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
## 截图
| macOS | Linux | Windows |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|  |  |  |
## 快速开始
### 安装
将此添加到你的软件包的 pubspec.yaml 文件：
```yaml
dependencies:
local_notifier: ^0.1.6
```
或
```yaml
dependencies:
local_notifier:
git:
url: https://github.com/leanflutter/local_notifier.git
ref: main
```
#### Linux requirements
- `libnotify`
运行以下命令
```
sudo apt-get install libnotify-dev
```
### 用法
```dart
// 在 main 方法中添加。
await localNotifier.setup(
appName: 'local_notifier_example',
// 参数 shortcutPolicy 仅适用于 Windows
shortcutPolicy: ShortcutPolicy.requireCreate,
);
LocalNotification notification = LocalNotification(
title: "local_notifier_example",
body: "hello flutter!",
);
notification.onShow = () {
print('onShow ${notification.identifier}');
};
notification.onClose = (closeReason) {
// 只支持在windows，其他平台 closeReason 始终为 unknown。
switch (closeReason) {
case LocalNotificationCloseReason.userCanceled:
// do something
break;
case LocalNotificationCloseReason.timedOut:
// do something
break;
default:
}
print('onClose ${_exampleNotification?.identifier} - $closeReason');
};
notification.onClick = () {
print('onClick ${notification.identifier}');
};
notification?.onClickAction = (actionIndex) {
print('onClickAction ${notification?.identifier} - $actionIndex');
};
notification.show();
```
> 请看这个插件的示例应用，以了解完整的例子。
## 谁在用使用它？
- [Biyi (比译)](https://biyidev.com/) - 一个便捷的翻译和词典应用。
## 相关链接
- https://github.com/mohabouje/WinToast
## 许可证
[MIT](./LICENSE)