https://github.com/djaus2/mauicountdowntoolkit
Implements a visual countdown timer.
https://github.com/djaus2/mauicountdowntoolkit
Last synced: 5 months ago
JSON representation
Implements a visual countdown timer.
- Host: GitHub
- URL: https://github.com/djaus2/mauicountdowntoolkit
- Owner: djaus2
- License: cc0-1.0
- Created: 2025-07-16T05:59:24.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-07-20T03:50:58.000Z (11 months ago)
- Last Synced: 2025-08-25T22:59:49.402Z (10 months ago)
- Language: C#
- Size: 576 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MauiCountdownToolkit
## CountdownPopup/RainbowCountdownPopup
> This is a Maui Countdown Popup that can be used to display a countdown timer in your Maui application.
> It is designed to be simple and easy to use, allowing you to quickly implement countdown functionality in your app.
> Two border options.
> [Cancel] button and can be programmatically cancelled. Displays an icon.
- Components:
`MauiCountdownToolkit.Views.CountdownPopup` Has one solid color border (default red).
`MauiCountdownToolkit.Views.RainbowCountdownPopup` Has rainbow border.
- NuGet Package:
[djaus2MauiCountdownToolkit](https://www.nuget.org/packages/djaus2MauiCountdownToolkit/)
## Popup Icon issue 2025-07-19
- Can use Icon from app but not Toolkit embedded versions
- 2 Nuget packages tried. Reverting at Version 1.1.6 where app icon works
### V1.1.3 CountDown class Interface
_(using MauiCountdownToolkit)_
```csharp
static abstract Countdown? Create(ContentPage? Page, CountDownMode Mode = CountDownMode.PopupRed, string IconSource = "", int IconSize = 100, string InitialText = "Starting...");
void Cancel();
Task Wait(int Delay);
```
- Parameters:
- `seconds`: The number of seconds for the countdown.
- `iconSource`: The source of the icon to display in the popup (default is "videogreen.svg").
- `color` **(CountdownPopup only)**: _The color of the border (default is `null`, which uses a default red)._
- `IconWidthHeight`: The width and height of the icon (default is 100).
- `initialText`: The initial text to display in the popup (default is "Starting...").
- `mode` = CountDownMode:
```cs
None, // No countdown
Soft, //Software only, countdown loop (New in this version)
PopupRed, //CountdownPopup
PopupRainbow //RainbowCountdownPopup
```
### Lower Interface _(Previous but will work)_
_(using MauiCountdownToolkit.Views)_
```csharp
public CountdownPopup(int seconds, SolidColorBrush? color = null, string iconSource = "videogreen.svg", int iconWidthHeight = 100, string initialText = "Starting...")
and
public RainbowCountdownPopup(int seconds, string iconSource = "videogreen.svg",int IconWidthHeight=100, string initialText= "Starting...")
```
- **Nb:** videogreen.svg, the default icon is in the lib
- You can use your own SVG icon from an app using this lib.*
- Make sure its property is set to MauiImage.
***The RainbowCountdownPopup in action using gunx.svg icon***
---
```*``` Icons embedded in the library:
Can be used without instantiation (inclusion) in the host app:
_Inbuilt icons don't currently work_
- gunx.svg
- videogreen.svg _(default)_
- videored.svg
- videoblack.svg
## Usage Example Version 1.1.0
```csharp
// Nb: Running from ContentPage
using MauiCountdownToolkit;
...
...
Countdown? countdown = null;
...
...
countdown? = Countdown.Create(this,CountDownMode.Red,"video.svg")
if(countdown != null)
{
bool response = await countdown.Wait(10);//10 second countdown
if (response)
{
// If cancel on the poup is press won't get here
//Call process to be triggered after countdown
}
}
...
...
//Elsewhere eg if process manual cancel button is pressed before countdown fimishes.
Countdown?.Cancel();
```
## Usage Example Previous
```csharp
using MauiCountdownToolkit.Views;
...
...
CountdownPopup? CountdownPopup = null;
...
...
int delay = //Get from app properties etc.
if (delay > 0)
{
CountdownPopup = new CountdownPopup(delay,null, "dotnet_athletics.jpg", 64,"Starting...");
await this.ShowPopupAsync(CountdownPopup);
bool result = await CountdownPopup.Result;
CountdownPopup = null;
if (result)
//Call process to be triggered after countdown
}
...
...
Elsewhere eg if process manual start button is pressed before countdown fimishes.
if (CountdownPopup != null)
{
// If a countdown popup is active, cancel it
CountdownPopup.Cancel();
}
```