Shiny.Extensions.Configuration 1.1.1

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Shiny.Extensions.Configuration --version 1.1.1                

                    
                

            
NuGet\Install-Package Shiny.Extensions.Configuration -Version 1.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Shiny.Extensions.Configuration" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Shiny.Extensions.Configuration --version 1.1.1                

                    
                

            
#r "nuget: Shiny.Extensions.Configuration, 1.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Shiny.Extensions.Configuration as a Cake Addin
#addin nuget:?package=Shiny.Extensions.Configuration&version=1.1.1

// Install Shiny.Extensions.Configuration as a Cake Tool
#tool nuget:?package=Shiny.Extensions.Configuration&version=1.1.1

Xamarin Configuration for Microsoft.Extensions.Configuration

Nugets

Release NuGet
Stable Nuget
Preview Nuget (with prereleases)

Builds

Branch Status
Master Build
Dev Build
Preview Build

Features

  • All the power of IConfiguration
  • Load JSON from packaged sources (whitelabellers can unpack, edit, & repack the config)
  • Preferences based configuration source with writebacks
  • Support For
    • Xamarin
      • iOS
      • Android
      • Including Xamarin Forms 😛
    • .NET 6
      • Android
      • iOS
      • Including MAUI 😛

The Problem

Microsoft really did create a great set of abstractions for configuration. You can store a set of key/values, cause a reload when a configuration source changes, & bind to strongly typed objects using Microsoft.Extensions.Configuration.Binder. On Mobile though, NONE of the current providers aren't really well.

Why?

  • A big feature for IConfiguration, is the ability to trigger a reload of it's source without restarting the application. Changing an appsettings.json file during runtime causes the IConfiguration to trigger a reload notification.
  • Mobile doesn't really have an appsettings.json. Sure you could put this in an embedded resource, but than it is readonly at all times other than the build process... after that - it is locked in place
  • Essentially, IConfiguration becomes a string based dictionary for all intents and purposes - pretty useless considering

The Solution

How Shiny.Extensions.Configuration brings the power of IConfiguration to Mobile!

  • A platform preferences configuration source which allows you to WRITE a value back using IConfiguration[key] = value;
  • A whitelabellers dream - the ability to unpack, change a json config file, and repack without trigger a build by using proper platform directories to load up the JSON files while still having the power of a proper configuration library internally.

Setup

AppSettings JSON
  1. Install the NuGet package 'Shiny.Extensions.Configuration'
  2. Create an appsettings.json file like you would in ASP.NET Core application in your HEAD project.
    • ANDROID: place the file in: Assets. Ensure the build action on the file is set to 'AndroidAsset'
    • iOS: place the file in the ROOT of your project. Ensure the build action on the file is set to 'BundleResource'
  3. Configure your IConfiguration using the following code in your application startup code (ie. Xamarin.Forms App).
// store this in your dependency injection container OR static class
var config = new ConfigurationBuilder()
    .AddJsonPlatformBundle() // NOTE: you can change the name of appsettings.json to something else and pass as an argument here
    .Build();
Preferences Provider

This provider allows writes and persists across application restarts. It is a wrapper around the Android/iOS shared preferences.

  1. Install the NuGet package 'Shiny.Extensions.Configuration'
  2. For this configuration source, nothing special is required, simply add the following to the configuration builder:
var configuration = new ConfigurationBuilder()
    .AddPlatformPreferences()
    .Build();

NOTE: with the platform preferences provider, changes are supported.

IConfiguration config = ...; // build
config["key"] = "value"; // write - this will cause a persist to the platform prefs and also trigger Option reloated events
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-android31.0 is compatible.  net6.0-ios was computed.  net6.0-ios15.2 is compatible.  net6.0-maccatalyst was computed.  net6.0-maccatalyst15.2 is compatible.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed.  monoandroid12.0 is compatible. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed.  xamarinios10 is compatible. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0-beta-0040 3,051 6/14/2024
3.3.3 8,584 4/8/2024
3.3.3-beta-0007 95 4/8/2024
3.3.3-beta-0003 89 4/8/2024
3.3.2 279 3/26/2024
3.3.1 115 3/26/2024
3.3.0 246 3/18/2024
3.3.0-beta-0011 103 3/14/2024
3.3.0-beta-0009 105 3/12/2024
3.3.0-beta-0003 115 2/28/2024
3.2.4 1,461 2/3/2024
3.2.4-beta-0004 82 2/3/2024
3.2.4-beta-0002 89 2/2/2024
3.2.3 209 1/19/2024
3.2.2 699 1/3/2024
3.2.1 1,093 12/20/2023
3.2.0 294 12/11/2023
3.2.0-beta-0049 86 1/12/2024
3.2.0-beta-0042 110 1/3/2024
3.2.0-beta-0041 79 1/3/2024
3.2.0-beta-0034 92 12/20/2023
3.2.0-beta-0025 114 12/10/2023
3.2.0-beta-0022 138 11/29/2023
3.2.0-beta-0019 114 11/25/2023
3.2.0-beta-0010 124 11/11/2023
3.2.0-beta-0006 114 11/8/2023
3.1.2 776 11/8/2023
3.1.1 224 11/2/2023
3.1.0 397 10/27/2023
3.1.0-beta-0018 105 11/2/2023
3.1.0-beta-0007 121 10/17/2023
3.1.0-beta-0005 117 10/14/2023
3.1.0-beta-0004 93 10/14/2023
3.0.1 665 9/20/2023
3.0.1-beta-0016 115 9/20/2023
3.0.1-beta-0002 145 9/14/2023
3.0.0 668 9/5/2023
3.0.0-beta-0305 136 9/1/2023
3.0.0-beta-0301 119 8/31/2023
3.0.0-beta-0300 139 8/31/2023
3.0.0-beta-0296 130 8/28/2023
3.0.0-beta-0293 126 8/28/2023
3.0.0-beta-0292 130 8/28/2023
3.0.0-beta-0282 143 8/25/2023
3.0.0-beta-0277 158 8/20/2023
3.0.0-beta-0273 128 8/20/2023
3.0.0-beta-0257 151 8/15/2023
3.0.0-beta-0245 166 8/8/2023
3.0.0-beta-0241 352 7/31/2023
3.0.0-beta-0231 146 7/25/2023
3.0.0-beta-0230 146 7/25/2023
3.0.0-beta-0215 162 7/18/2023
3.0.0-beta-0210 383 7/12/2023
3.0.0-beta-0200 150 7/5/2023
3.0.0-beta-0199 152 7/5/2023
3.0.0-beta-0179 374 6/27/2023
3.0.0-beta-0174 155 6/26/2023
3.0.0-beta-0165 148 6/22/2023
3.0.0-beta-0154 157 6/17/2023
3.0.0-beta-0153 150 6/16/2023
3.0.0-beta-0124 545 6/1/2023
3.0.0-beta-0122 252 5/31/2023
3.0.0-beta-0116 140 5/30/2023
3.0.0-beta-0114 148 5/29/2023
3.0.0-beta-0092 185 5/16/2023
3.0.0-beta-0081 144 5/13/2023
3.0.0-beta-0073 138 5/12/2023
3.0.0-beta-0039 162 5/7/2023
3.0.0-beta-0031 137 5/5/2023
3.0.0-beta-0026 194 4/28/2023
3.0.0-beta-0023 150 4/26/2023
3.0.0-beta-0015 172 4/22/2023
3.0.0-beta-0001 271 4/14/2023
3.0.0-alpha-0608 124 4/13/2023
3.0.0-alpha-0604 135 4/13/2023
3.0.0-alpha-0593 205 4/7/2023
3.0.0-alpha-0560 1,182 3/28/2023
3.0.0-alpha-0557 142 3/27/2023
3.0.0-alpha-0552 146 3/26/2023
3.0.0-alpha-0550 148 3/25/2023
3.0.0-alpha-0548 142 3/25/2023
3.0.0-alpha-0545 147 3/25/2023
3.0.0-alpha-0543 164 3/24/2023
3.0.0-alpha-0540 138 3/24/2023
3.0.0-alpha-0533 4,331 3/14/2023
3.0.0-alpha-0532 148 3/12/2023
3.0.0-alpha-0530 237 3/6/2023
3.0.0-alpha-0523 195 3/1/2023
3.0.0-alpha-0516 158 2/27/2023
3.0.0-alpha-0513 124 2/26/2023
3.0.0-alpha-0497 129 2/23/2023
3.0.0-alpha-0496 642 2/4/2023
3.0.0-alpha-0495 652 1/12/2023
3.0.0-alpha-0491 357 12/24/2022
3.0.0-alpha-0489 161 12/23/2022
3.0.0-alpha-0470 153 12/15/2022
3.0.0-alpha-0427 266 12/4/2022
3.0.0-alpha-0423 160 12/1/2022
3.0.0-alpha-0402 305 11/19/2022
3.0.0-alpha-0399 232 11/12/2022
3.0.0-alpha-0396 149 11/12/2022
3.0.0-alpha-0392 198 10/29/2022
3.0.0-alpha-0391 164 10/27/2022
3.0.0-alpha-0387 309 10/25/2022
3.0.0-alpha-0384 179 10/25/2022
3.0.0-alpha-0376 167 10/7/2022
3.0.0-alpha-0370 166 10/4/2022
3.0.0-alpha-0360 137 10/3/2022
3.0.0-alpha-0354 175 10/1/2022
3.0.0-alpha-0348 194 9/26/2022
3.0.0-alpha-0344 163 9/25/2022
3.0.0-alpha-0343 153 9/24/2022
3.0.0-alpha-0338 160 9/22/2022
3.0.0-alpha-0329 142 9/20/2022
3.0.0-alpha-0310 203 9/3/2022
3.0.0-alpha-0283 160 8/24/2022
3.0.0-alpha-0266 190 8/13/2022
3.0.0-alpha-0245 170 8/10/2022
3.0.0-alpha-0225 181 8/9/2022
3.0.0-alpha-0216 159 8/7/2022
3.0.0-alpha-0208 173 8/5/2022
3.0.0-alpha-0204 153 7/31/2022
3.0.0-alpha-0181 169 7/25/2022
3.0.0-alpha-0172 145 7/22/2022
3.0.0-alpha-0167 186 7/19/2022
3.0.0-alpha-0160 168 7/18/2022
3.0.0-alpha-0158 165 7/18/2022
3.0.0-alpha-0157 173 7/17/2022
3.0.0-alpha-0156 158 7/16/2022
3.0.0-alpha-0155 176 7/15/2022
3.0.0-alpha-0142 146 7/14/2022
3.0.0-alpha-0128 196 6/16/2022
3.0.0-alpha-0102 162 6/6/2022
3.0.0-alpha-0099 163 6/2/2022
3.0.0-alpha-0090 159 5/25/2022
3.0.0-alpha-0087 160 5/24/2022
3.0.0-alpha-0084 160 5/24/2022
3.0.0-alpha-0082 176 5/23/2022
3.0.0-alpha-0079 158 5/21/2022
3.0.0-alpha-0075 178 5/20/2022
1.1.1 7,439 3/3/2022
1.0.0 202 5/27/2023

https://github.com/shinyorg/shiny/blob/master/CHANGELOG.md