Skip to content

This plugin allows Flutter desktop apps to notify local notifications.

License

Notifications You must be signed in to change notification settings

leanflutter/local_notifier

Repository files navigation

🚀 Ship Your App Faster: Try Fastforge - The simplest way to build, package and distribute your Flutter apps.

local_notifier

pub version

This plugin allows Flutter desktop apps to displaying local notifications.


English | 简体中文


Platform Support

LinuxmacOSWindows
✔️✔️✔️

Screenshots

macOSLinuxWindows
image

Quick Start

Installation

Add this to your package's pubspec.yaml file:

dependencies: local_notifier: ^0.1.6

Or

dependencies: local_notifier: git: url: https://github.com/leanflutter/local_notifier.gitref: main

Linux requirements

  • libnotify

Run the following command

sudo apt-get install libnotify-dev 

Usage

// Add in main method.await localNotifier.setup( appName:'local_notifier_example', // The parameter shortcutPolicy only works on Windows shortcutPolicy:ShortcutPolicy.requireCreate, ); LocalNotification notification =LocalNotification( title:"local_notifier_example", body:"hello flutter!", ); notification.onShow = (){print('onShow ${notification.identifier}')}; notification.onClose = (closeReason){// Only supported on windows, other platforms closeReason is always unknown.switch (closeReason){caseLocalNotificationCloseReason.userCanceled:// do somethingbreak; caseLocalNotificationCloseReason.timedOut:// do somethingbreak; default: } print('onClose ${_exampleNotification?.identifier} - $closeReason')}; notification.onClick = (){print('onClick ${notification.identifier}')}; notification?.onClickAction = (actionIndex){print('onClickAction ${notification?.identifier} - $actionIndex')}; notification.show();

Please see the example app of this plugin for a full example.

Who's using it?

Related Links

License

MIT

About

This plugin allows Flutter desktop apps to notify local notifications.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project