Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/LuckyDucko/AwaitablePopups

Customisable Popups for Xamarin Forms
https://github.com/LuckyDucko/AwaitablePopups

async await awaitable-popups csharp custom-popup dialogs loader popup popup-page popups userdialogs xamarin xamarin-forms xamarin-library xamarin-plugin

Last synced: 3 months ago
JSON representation

Customisable Popups for Xamarin Forms

Awesome Lists containing this project

README 

        






  
Awaitable Popups

  


    Customisable Popups for Xamarin Forms

    


  



## Table of Contents



[![NuGet Downloads](https://img.shields.io/nuget/dt/AwaitablePopups.svg)](https://www.nuget.org/packages/AwaitablePopups/)

[![nuget](https://img.shields.io/nuget/v/AwaitablePopups.svg)](https://www.nuget.org/packages/AwaitablePopups/)



https://www.fuget.org/packages/AwaitablePopups/badges

* [About the Project](#about-the-project)

  * [Built With](#built-with)

* [Getting Started](#getting-started)

  * [Installation](#installation)

* [Usage](#usage)

* [Contributing](#contributing)

* [License](#license)

* [Contact](#contact)

* [Acknowledgements](#acknowledgements)



## About The Project



Awaitable Popups is a neat blend of the Rg.Plugins.Popup and AsyncAwaitBestPractices plugins to bring you a quick way to add popups into your Xamarin Forms App using familiar concepts 



### Built With

* [Rg.Plugins.Popup](https://github.com/rotorgames/Rg.Plugins.Popup)

* [AsyncAwaitBestPractices](https://github.com/brminnick/AsyncAwaitBestPractices)



## Getting Started



First, you must follow the [initialisation](https://github.com/rotorgames/Rg.Plugins.Popup/wiki/Getting-started)

 guide set out by Rg.Plugins.Popup, once you have that, have a look at usage down below



### Installation



You can install the nuget by looking up 'AwaitablePopups' in your nuget package manager, or by getting it [here](https://www.nuget.org/packages/AwaitablePopups/)



## Usage

here is an example of what this plugin makes easy (Looks slow due to giphy)



![Gif Example](https://j.gifs.com/xn4mw9.gif)



### New Example

To Use the plugin for its inbuilt popup pages in a basic setting (Dual/Single Response, Login, TextInput EntryInput,and loader.) All you need are these one liners



`SingleResponse Popup Page`

```csharp

return await SingleResponseViewModel.AutoGenerateBasicPopup(Color.HotPink, Color.Black, "I Accept", Color.Gray, "Good Job, enjoy this single response example", "thumbsup.png");

```



`DualResponse Popup Page`

```csharp

return await DualResponseViewModel.AutoGenerateBasicPopup(Color.WhiteSmoke, Color.Red, "Okay", Color.WhiteSmoke, Color.Green, "Looks Good!", Color.DimGray, "This is an example of a dual response popup page", "thumbsup.png");

```



`Loader Popup Page`

```csharp

  await PopupService.WrapTaskInLoader(Task.Delay(10000), Color.Blue, Color.White, LoadingReasons(), Color.Black);

```



`Text Input PopupPage`

```csharp

await TextInputViewModel.AutoGenerateBasicPopup(Color.WhiteSmoke, Color.Red, "Cancel", Color.WhiteSmoke, Color.Green, "Submit", Color.DimGray, "Text input Example", string.Empty);

```

`Entry Input PopupPage`

```csharp

await EntryInputViewModel.AutoGenerateBasicPopup(Color.WhiteSmoke, Color.Red, "Cancel", Color.WhiteSmoke, Color.Green, "Submit", Color.DimGray, "Text input Example", string.Empty);

```



`LoginPage PopupPage`

```csharp

var (username, password) = await LoginViewModel.AutoGenerateBasicPopup(Color.WhiteSmoke, Color.Red, "Cancel", Color.WhiteSmoke, Color.Green, "Submit", Color.DimGray, string.Empty, "Username Here", string.Empty, "Password here", "thumbsup.png", 0, 0);

```



or, to return from the loader a value

```csharp

await PopupService.WrapReturnableTaskInLoader(IndepthCheckAgainstDatabase(), Color.Blue, Color.White, LoadingReasons(), Color.Black);

```



you can also add in synchronous functions, however they are wrapped in a task

```csharp



private bool LongRunningFunction(int millisecondDelay)

{

    Thread.Sleep(millisecondDelay);

    return true;

}

await PopupService.WrapReturnableFuncInLoader(LongRunningFunction, 6000, Color.Blue, Color.White, LoadingReasons(), Color.Black);



```



## That's it! for advanced usage read on



In Version 1.1.0, AwaitablePopups will be starting on a new set of API's



This set of API's will be used for when the basic API wont cut it, without relying on me making another overload for every situation under the sun.



This API introduces



 `GeneratePopup`

Which allows you to supply your own popuppage xaml which will then be attached to whatever VM you called it from. 



`GeneratePopup(Dictionary propertyDictionary)`

Which allows you have a dictionary of values that a popup uses, pass and automatically attach to the appropriate properties on the VM side



These are both non-static. and require you to have an instance of the ViewModel to work with. Hence



`.GenerateVM()`

Which provides you with a new instance of that VM



`.PullViewModelProperties()`

Which collects all the properties of a VM, and provides them to you in a dictionary, so you can reuse and also while debugging, check what exists/whats been changed 

Returns this `Dictionary `



However, for initialisation, i internally (and you can use) the following function

`.InitialiseOptionalProperties(Dictionary optionalProperties)`

Which will attempt to set each of the viewmodel properties with the corrosponding value in the dictionary



So, to fix that, i provide

`.FinalisePreparedProperties(Dictionary viewModelProperties)`

Which takes in the `Dictionary ` and creates `Dictionary optionalProperties`



Hopefully i will add on to make this easier in the future



**If you want to make your own Popup Page**



This is the real power of this Plugin (Thanks in no small amount to Rotorgames amazing plugin). If you look at the source for DualResponsePopupPage, or the SingleResponse version you'll notice that they are just simple Xaml Pages. Nothing fancy. (except for the rg popup spice). 



You can create the full thing yourself

1. Create Xaml Page with codebehind

2. Create your ViewModel that is associated with the popup, lets call ours `InformationPopupPage`

3. Ensure your ViewModel inherits from `PopupViewModel` where `TReturnable` is what you want the popuppage to return to its caller

4. Ensure that your xaml page codebehind inherits from `PopupPage` (requirement to use rg plugins popup) and `IGenericViewModel` where `TViewModel` is your Viewmodel, in our case it will be `IGenericViewModel`

5. You're ready to start using it the same as `DualResponsePopupPage`



**New API Usage (1.1.0)**

or you can provide your own Xaml Page, with a codebehind that inherits from `PopupPage` and `IGenericViewModel` where `TViewModel` is the plugin provided VM you wish to use.



to use this version, just call `TViewModel.GeneratePopup()`



## License



This project uses the MIT License



## Contact



My [Github](https://github.com/LuckyDucko),

or reach me on the [Xamarin Slack](https://xamarinchat.herokuapp.com/),

or on my [E-mail]([email protected])



Project Link: [AwaitablePopups](https://github.com/LuckyDucko/AwaitablePopups)



## Acknowledgements

* [Brimmick](https://github.com/brminnick) has been a model to follow