Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thudugala/Plugin.LocalNotification

The local notification plugin provides a way to show local notifications from .Net MAUI and Xamarin Forms apps .
https://github.com/thudugala/Plugin.LocalNotification

local maui notifications xamarin xamarin-forms

Last synced: 3 months ago
JSON representation

The local notification plugin provides a way to show local notifications from .Net MAUI and Xamarin Forms apps .

Awesome Lists containing this project

README

        

![icon64](https://user-images.githubusercontent.com/4112014/139563161-b7f3cdba-e161-4f6c-80ae-45f0253c4340.png)

![CI](https://github.com/thudugala/Plugin.LocalNotification/workflows/CI/badge.svg?branch=master)
[![NuGet](https://img.shields.io/nuget/v/Plugin.LocalNotification.svg)](https://www.nuget.org/packages/Plugin.LocalNotification/)
[![NuGet](https://img.shields.io/nuget/dt/Plugin.LocalNotification.svg)](https://www.nuget.org/packages/Plugin.LocalNotification/)

# Plugin.LocalNotification
The local notification plugin provides a way to show local notifications from Xamarin.Forms / .Net MAUI apps.

# Setup

- `Plugin.LocalNotification` Available on NuGet: https://www.nuget.org/packages/Plugin.LocalNotification
- #### .Net MAUI
- Install Version 10.0.0 above
- Install into your project
- #### Xamarin.Forms (Support ended on May 1, 2024)
- - Install Version 11.0.0 below
- Install into your platform-specific projects (iOS/Android), and any .NET Standard 2.0/2.1 projects required for your app.

## Platform Support

| Feature | Xamarin.iOS | Xamarin.Android | net8.0-ios (>= 11) | net8.0-android (>= 11) |
| ----------------------------- | ----------- | --------------- | ------------------ | ---------------------- |
| Build SDK | >= 10 | >= API 31 | >= 16 | >= API 34 |
| Supported OS Version | >= 10 | >= API 19 | >= 11 | >= API 21 |
| Title | ✅ | ✅ | ✅ | ✅ |
| Description | ✅ | ✅ | ✅ | ✅ |
| Subtitle | ✅ | ✅ | ✅ | ✅ |
| [Schedule](https://github.com/thudugala/Plugin.LocalNotification/wiki/3.-Scheduled-Android-notifications) | ✅ | ✅ | ✅ | ✅ |
| [Repeat](https://github.com/thudugala/Plugin.LocalNotification/wiki/4.-Repeat-Notification) | ✅ | ✅ | ✅ | ✅ |
| [Custom Sounds](https://github.com/thudugala/Plugin.LocalNotification/wiki/Notification-with-a-Sound-File) | ✅ | ✅ | ✅ | ✅ |
| Images | ✅ | ✅ | ✅ | ✅ |
| [Notification Actions](https://github.com/thudugala/Plugin.LocalNotification/wiki/5.-Notification-with-Action) | ✅ | ✅ | ✅ | ✅ |
| Clear Delivered Notifications | ✅ | ✅ | ✅ | ✅ |
| Get Pending Notifications | ✅ | ✅ | ✅ | ✅ |
| Get Delivered Notifications | ✅ | ✅ | ✅ | ✅ |
| [Location Notifications](https://github.com/thudugala/Plugin.LocalNotification/wiki/Location-Notifications) | ✅ | ✅ | ✅ | ✅ |

# Usage

- [Xamarin.Forms](https://github.com/thudugala/Plugin.LocalNotification/wiki#xamarinforms-support-ended-on-may-1-2024)
- [.Net MAUI](https://github.com/thudugala/Plugin.LocalNotification/wiki/1.-Usage-10.0.0--.Net-MAUI)

# Screen Record

Screen Record

# Video

### Xamarin.Forms (Support ended on May 1, 2024)
[![Local Push Notifications in Xamarin.Forms](https://img.youtube.com/vi/-Nj_TRPlx-8/0.jpg)](https://www.youtube.com/watch?v=-Nj_TRPlx-8)

### .Net MAUI
[![Local Push Notifications in .Net MAUI](https://img.youtube.com/vi/dWdXXGa1_hI/0.jpg)](https://www.youtube.com/watch?v=dWdXXGa1_hI)

# SourceLink Support

In Visual Studio, confirm that SourceLink is enabled.
Also, Turn off "Just My Code" since, well, this isn't your code.

https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink

# Limitations

Only support iOS and Android for the moment.

# Contributing

Contributions are welcome. Feel free to file issues and pull requests on the repo and they'll be reviewed as time permits.

## Thank you

- Thank you for the Icons by [DinosoftLabs](https://www.iconfinder.com/dinosoftlabs) and [Iconic Hub](https://www.iconfinder.com/iconic_hub)
- Thank you for the sound file by [Notification sounds](https://notificationsounds.com/notification-sounds/good-things-happen-547)
- Thank you for the tutorial video by [Gerald Versluis](https://www.youtube.com/channel/UCBBZ2kXWmd8eXlHg2wEaClw)