Shiny Framework Libraries

These libraries were written by the author for the author and thus are not open to issues, enhancements, or anything in between.

Shiny.Framework

Framework combines the best of MVVM using Prism & ReactiveUI while also combining Shiny. Find the sample at [https://github.com/shinyorg/samples/tree/main/Integration-Best-Prism-RXUI]

Features

• Simplified configuration - Prism & Shiny setup under one file using FrameworkStartup
• No guess work about what dependency injection mechanism to install - Framework uses DryIoc under the hood, but guess what.... you'll NEVER know it even if this changes one day
• Dialogs - a pretty API that brings together XF Material (built on RG Popups)
• Localization - a simple to use localization framework that can be used everywhere including your viewmodels! Localization DONE RIGHT!
• Global Navigator - allows you to inject a global navigator that you can use safely from your Shiny delegates. Will ignore navigation requests when in the background
• Global Command Exception Handler - do you like ReactiveCommand, so do I... this little service brings together Shiny's logging services + localization (from above) + dialogs (also from above) into one singular place
• ViewModel Validation using Data Annotations by default (but can be changed to 3rd party by implementing IValidationService)

Nugets

Release	NuGet
Stable
Preview

Wiring Up (Prism Plus Shiny)

• First install Shiny.Framework from NuGet
• Setup your App.xaml like so (NOTE: you can add resources like normal):

<?xml version="1.0" encoding="utf-8" ?>
<shiny:FrameworkApplication xmlns="http://xamarin.com/schemas/2014/forms"
                            xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                            xmlns:shiny="clr-namespace:Shiny;assembly=Shiny.Framework"
                            x:Class="Samples.App">
</shiny:FrameworkApplication>

• add the following to your app.xaml.cs

using System;

namespace YourNamespace
{
    public partial class App : Shiny.FrameworkApplication
    {
        protected override void Initialize()
        {
            XF.Material.Forms.Material.Init(this); // if you are using XF Material dialogs
            this.InitializeComponent();
            base.Initialize();
        }
    }
}

• Now you are ready to implement a Shiny Startup/Prism Definition. Here is an example:

  namespace YourNamespace
  {
    public class YourStartupClassName : Shiny.FrameworkStartup
    {
        protected override void Configure(ILoggingBuilder builder, IServiceCollection services)
        {
            // any services you register with Prism or Shiny should go here
        }
  
        // your start page so Prism knows where to go
        public override Task RunApp(INavigationService navigator)
            => navigator.Navigate("NavigationPage/MainPage"); 
  
        // register your Prism pages
        public override void ConfigureApp(Application app, IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterForNavigation<OtherPage, OtherViewModel>();
        }
    }
  }
  

Localization

This uses Shiny.Extensions.Localization

namespace YourNamespace
{
    public class YourStartupClassName : Shiny.FrameworkStartup
    {
        protected override void Configure(ILoggingBuilder builder, IServiceCollection services)
        {
            services.ConfigureLocalization(x => 
                .AddResource("Samples.Resources.Strings", this.GetType().Assembly, "Strings")
                .AddResource("Samples.Resources.Enums", this.GetType().Assembly, "Enums")
            );
        }
    }
}

Dialogs

We recommend installing Shiny.Extensions.Dialogs.XfMaterial for a full experience. However, if you don't, we use standard native dialogs under the hood. However, you will be missing loading & snackbar with the default implementation.

To use XF Material Dialogs

public class SampleStartup : FrameworkStartup
{
    protected override void Configure(ILoggingBuilder builder, IServiceCollection services)
    {
        services.UseXfMaterialDialogs();
    }
}

For examples on what methods are available in dialogs, take a look here: Dialog Samples

Global Command Exception Handler

Global command exception handling is something provided by ReactiveUI. It saves you the hassle of putting a standard try {} catch (Exception ex) {} trap all in every command.

Shiny builds on this by adding logging and a standard dialog message to handle trap-all scenarios. To use it, simply add the following to your framework startup:

namespace YourNamespace
{
    public class YourStartupClassName : Shiny.FrameworkStartup
    {
        protected override void Configure(ILoggingBuilder builder, IServiceCollection services)
        {
            services.UseGlobalCommandExceptionHandler(options =>
            {
#if DEBUG
                options.AlertType = ErrorAlertType.FullError; // this will show the full error in a dialog during debug
                options.LogError = false;
#else
                // you will need localization to be registered to use this
                options.AlertType = ErrorAlertType.Localize; // you can use NoLocalize which will send a standard english message instead
                options.LogError = true;
                options.IgnoreTokenCancellations = true;
                options.LocalizeErrorTitleKey = "YourLocalizationTitleKey";
                options.LocalizeErrorBodyKey = "YourLocalizationErrorBodyMessageKey";
#endif
            });
        }
    }
}