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. 
<PackageVersion Include="Shiny.Extensions.Configuration" Version="1.1.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Shiny.Extensions.Configuration" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version 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. 
#addin nuget:?package=Shiny.Extensions.Configuration&version=1.1.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Shiny.Extensions.Configuration&version=1.1.1
                    


                            Install as a Cake Tool

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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-0086 136 6/23/2025
4.0.0-beta-0084 140 6/4/2025
4.0.0-beta-0083 134 6/3/2025
4.0.0-beta-0081 60 5/30/2025
4.0.0-beta-0079 140 5/29/2025
4.0.0-beta-0075 73 5/24/2025
4.0.0-beta-0069 211 4/8/2025
4.0.0-beta-0061 147 4/3/2025
4.0.0-beta-0057 153 4/1/2025
4.0.0-beta-0055 129 3/27/2025
4.0.0-beta-0054 467 3/26/2025
4.0.0-beta-0049 86 3/21/2025
4.0.0-beta-0048 95 3/21/2025
4.0.0-beta-0047 152 3/20/2025
4.0.0-beta-0040 3,559 6/14/2024
3.4.0-beta-0010 195 3/6/2025
3.4.0-beta-0009 94 2/5/2025
3.4.0-beta-0006 86 2/4/2025
3.4.0-beta-0005 93 2/4/2025
3.4.0-beta-0003 102 2/4/2025
3.3.4 6,109 1/15/2025
3.3.3 13,634 4/8/2024
3.3.3-beta-0007 122 4/8/2024
3.3.3-beta-0003 102 4/8/2024
3.3.2 318 3/26/2024
3.3.1 151 3/26/2024
3.3.0 278 3/18/2024
3.3.0-beta-0011 124 3/14/2024
3.3.0-beta-0009 123 3/12/2024
3.3.0-beta-0003 135 2/28/2024
3.2.4 1,774 2/3/2024
3.2.4-beta-0004 100 2/3/2024
3.2.4-beta-0002 103 2/2/2024
3.2.3 240 1/19/2024
3.2.2 750 1/3/2024
3.2.1 1,234 12/20/2023
3.2.0 329 12/11/2023
3.2.0-beta-0049 101 1/12/2024
3.2.0-beta-0042 130 1/3/2024
3.2.0-beta-0041 94 1/3/2024
3.2.0-beta-0034 105 12/20/2023
3.2.0-beta-0025 129 12/10/2023
3.2.0-beta-0022 150 11/29/2023
3.2.0-beta-0019 126 11/25/2023
3.2.0-beta-0010 141 11/11/2023
3.2.0-beta-0006 129 11/8/2023
3.1.2 805 11/8/2023
3.1.1 241 11/2/2023
3.1.0 550 10/27/2023
3.1.0-beta-0018 121 11/2/2023
3.1.0-beta-0007 139 10/17/2023
3.1.0-beta-0005 137 10/14/2023
3.1.0-beta-0004 114 10/14/2023
3.0.1 687 9/20/2023
3.0.1-beta-0016 137 9/20/2023
3.0.1-beta-0002 164 9/14/2023
3.0.0 755 9/5/2023
3.0.0-beta-0305 160 9/1/2023
3.0.0-beta-0301 141 8/31/2023
3.0.0-beta-0300 162 8/31/2023
3.0.0-beta-0296 152 8/28/2023
3.0.0-beta-0293 155 8/28/2023
3.0.0-beta-0292 155 8/28/2023
3.0.0-beta-0282 167 8/25/2023
3.0.0-beta-0277 185 8/20/2023
3.0.0-beta-0273 151 8/20/2023
3.0.0-beta-0257 178 8/15/2023
3.0.0-beta-0245 193 8/8/2023
3.0.0-beta-0241 378 7/31/2023
3.0.0-beta-0231 171 7/25/2023
3.0.0-beta-0230 171 7/25/2023
3.0.0-beta-0215 195 7/18/2023
3.0.0-beta-0210 413 7/12/2023
3.0.0-beta-0200 179 7/5/2023
3.0.0-beta-0199 184 7/5/2023
3.0.0-beta-0179 406 6/27/2023
3.0.0-beta-0174 185 6/26/2023
3.0.0-beta-0165 179 6/22/2023
3.0.0-beta-0154 188 6/17/2023
3.0.0-beta-0153 184 6/16/2023
3.0.0-beta-0124 591 6/1/2023
3.0.0-beta-0122 290 5/31/2023
3.0.0-beta-0116 177 5/30/2023
3.0.0-beta-0114 184 5/29/2023
3.0.0-beta-0092 224 5/16/2023
3.0.0-beta-0081 181 5/13/2023
3.0.0-beta-0073 172 5/12/2023
3.0.0-beta-0039 199 5/7/2023
3.0.0-beta-0031 177 5/5/2023
3.0.0-beta-0026 232 4/28/2023
3.0.0-beta-0023 189 4/26/2023
3.0.0-beta-0015 205 4/22/2023
3.0.0-beta-0001 312 4/14/2023
3.0.0-alpha-0608 163 4/13/2023
3.0.0-alpha-0604 171 4/13/2023
3.0.0-alpha-0593 247 4/7/2023
3.0.0-alpha-0560 1,222 3/28/2023
3.0.0-alpha-0557 180 3/27/2023
3.0.0-alpha-0552 181 3/26/2023
3.0.0-alpha-0550 185 3/25/2023
3.0.0-alpha-0548 181 3/25/2023
3.0.0-alpha-0545 185 3/25/2023
3.0.0-alpha-0543 198 3/24/2023
3.0.0-alpha-0540 179 3/24/2023
3.0.0-alpha-0533 4,390 3/14/2023
3.0.0-alpha-0532 186 3/12/2023
3.0.0-alpha-0530 276 3/6/2023
3.0.0-alpha-0523 229 3/1/2023
3.0.0-alpha-0516 193 2/27/2023
3.0.0-alpha-0513 161 2/26/2023
3.0.0-alpha-0497 168 2/23/2023
3.0.0-alpha-0496 692 2/4/2023
3.0.0-alpha-0495 690 1/12/2023
3.0.0-alpha-0491 397 12/24/2022
3.0.0-alpha-0489 197 12/23/2022
3.0.0-alpha-0470 192 12/15/2022
3.0.0-alpha-0427 305 12/4/2022
3.0.0-alpha-0423 200 12/1/2022
3.0.0-alpha-0402 351 11/19/2022
3.0.0-alpha-0399 270 11/12/2022
3.0.0-alpha-0396 187 11/12/2022
3.0.0-alpha-0392 238 10/29/2022
3.0.0-alpha-0391 200 10/27/2022
3.0.0-alpha-0387 351 10/25/2022
3.0.0-alpha-0384 215 10/25/2022
3.0.0-alpha-0376 203 10/7/2022
3.0.0-alpha-0370 202 10/4/2022
3.0.0-alpha-0360 175 10/3/2022
3.0.0-alpha-0354 213 10/1/2022
3.0.0-alpha-0348 234 9/26/2022
3.0.0-alpha-0344 203 9/25/2022
3.0.0-alpha-0343 189 9/24/2022
3.0.0-alpha-0338 205 9/22/2022
3.0.0-alpha-0329 182 9/20/2022
3.0.0-alpha-0310 244 9/3/2022
3.0.0-alpha-0283 198 8/24/2022
3.0.0-alpha-0266 235 8/13/2022
3.0.0-alpha-0245 213 8/10/2022
3.0.0-alpha-0225 221 8/9/2022
3.0.0-alpha-0216 202 8/7/2022
3.0.0-alpha-0208 214 8/5/2022
3.0.0-alpha-0204 193 7/31/2022
3.0.0-alpha-0181 213 7/25/2022
3.0.0-alpha-0172 191 7/22/2022
3.0.0-alpha-0167 228 7/19/2022
3.0.0-alpha-0160 212 7/18/2022
3.0.0-alpha-0158 209 7/18/2022
3.0.0-alpha-0157 218 7/17/2022
3.0.0-alpha-0156 202 7/16/2022
3.0.0-alpha-0155 217 7/15/2022
3.0.0-alpha-0142 191 7/14/2022
3.0.0-alpha-0128 247 6/16/2022
3.0.0-alpha-0102 211 6/6/2022
3.0.0-alpha-0099 211 6/2/2022
3.0.0-alpha-0090 211 5/25/2022
3.0.0-alpha-0087 209 5/24/2022
3.0.0-alpha-0084 206 5/24/2022
3.0.0-alpha-0082 222 5/23/2022
3.0.0-alpha-0079 204 5/21/2022
3.0.0-alpha-0075 221 5/20/2022
1.1.1 8,200 3/3/2022
1.0.0 265 5/27/2023

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