Shiny.Extensions.Configuration 1.1.1

Prefix Reserved
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.
#:package Shiny.Extensions.Configuration@1.1.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code 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-0095 402 10/28/2025
4.0.0-beta-0093 185 9/21/2025
4.0.0-beta-0092 308 9/17/2025
4.0.0-beta-0091 183 8/18/2025
4.0.0-beta-0086 219 6/23/2025
4.0.0-beta-0084 187 6/4/2025
4.0.0-beta-0083 172 6/3/2025
4.0.0-beta-0081 99 5/30/2025
4.0.0-beta-0079 201 5/29/2025
4.0.0-beta-0075 129 5/24/2025
4.0.0-beta-0069 262 4/8/2025
4.0.0-beta-0061 189 4/3/2025
4.0.0-beta-0057 192 4/1/2025
4.0.0-beta-0055 167 3/27/2025
4.0.0-beta-0054 509 3/26/2025
4.0.0-beta-0049 124 3/21/2025
4.0.0-beta-0048 135 3/21/2025
4.0.0-beta-0047 190 3/20/2025
4.0.0-beta-0040 4,127 6/14/2024
3.4.0-beta-0010 224 3/6/2025
3.4.0-beta-0009 133 2/5/2025
3.4.0-beta-0006 121 2/4/2025
3.4.0-beta-0005 128 2/4/2025
3.4.0-beta-0003 139 2/4/2025
3.3.4 10,426 1/15/2025
3.3.3 14,214 4/8/2024
3.3.3-beta-0007 155 4/8/2024
3.3.3-beta-0003 141 4/8/2024
3.3.2 386 3/26/2024
3.3.1 226 3/26/2024
3.3.0 327 3/18/2024
3.3.0-beta-0011 151 3/14/2024
3.3.0-beta-0009 162 3/12/2024
3.3.0-beta-0003 171 2/28/2024
3.2.4 1,846 2/3/2024
3.2.4-beta-0004 137 2/3/2024
3.2.4-beta-0002 139 2/2/2024
3.2.3 306 1/19/2024
3.2.2 808 1/3/2024
3.2.1 1,299 12/20/2023
3.2.0 389 12/11/2023
3.2.0-beta-0049 130 1/12/2024
3.2.0-beta-0042 166 1/3/2024
3.2.0-beta-0041 129 1/3/2024
3.2.0-beta-0034 140 12/20/2023
3.2.0-beta-0025 162 12/10/2023
3.2.0-beta-0022 181 11/29/2023
3.2.0-beta-0019 162 11/25/2023
3.2.0-beta-0010 176 11/11/2023
3.2.0-beta-0006 154 11/8/2023
3.1.2 846 11/8/2023
3.1.1 276 11/2/2023
3.1.0 587 10/27/2023
3.1.0-beta-0018 156 11/2/2023
3.1.0-beta-0007 179 10/17/2023
3.1.0-beta-0005 172 10/14/2023
3.1.0-beta-0004 153 10/14/2023
3.0.1 722 9/20/2023
3.0.1-beta-0016 168 9/20/2023
3.0.1-beta-0002 200 9/14/2023
3.0.0 819 9/5/2023
3.0.0-beta-0305 208 9/1/2023
3.0.0-beta-0301 189 8/31/2023
3.0.0-beta-0300 210 8/31/2023
3.0.0-beta-0296 202 8/28/2023
3.0.0-beta-0293 206 8/28/2023
3.0.0-beta-0292 200 8/28/2023
3.0.0-beta-0282 201 8/25/2023
3.0.0-beta-0277 237 8/20/2023
3.0.0-beta-0273 205 8/20/2023
3.0.0-beta-0257 221 8/15/2023
3.0.0-beta-0245 249 8/8/2023
3.0.0-beta-0241 427 7/31/2023
3.0.0-beta-0231 220 7/25/2023
3.0.0-beta-0230 219 7/25/2023
3.0.0-beta-0215 246 7/18/2023
3.0.0-beta-0210 466 7/12/2023
3.0.0-beta-0200 235 7/5/2023
3.0.0-beta-0199 237 7/5/2023
3.0.0-beta-0179 464 6/27/2023
3.0.0-beta-0174 243 6/26/2023
3.0.0-beta-0165 240 6/22/2023
3.0.0-beta-0154 253 6/17/2023
3.0.0-beta-0153 244 6/16/2023
3.0.0-beta-0124 653 6/1/2023
3.0.0-beta-0122 356 5/31/2023
3.0.0-beta-0116 228 5/30/2023
3.0.0-beta-0114 249 5/29/2023
3.0.0-beta-0092 289 5/16/2023
3.0.0-beta-0081 249 5/13/2023
3.0.0-beta-0073 235 5/12/2023
3.0.0-beta-0039 268 5/7/2023
3.0.0-beta-0031 251 5/5/2023
3.0.0-beta-0026 298 4/28/2023
3.0.0-beta-0023 252 4/26/2023
3.0.0-beta-0015 275 4/22/2023
3.0.0-beta-0001 380 4/14/2023
3.0.0-alpha-0608 237 4/13/2023
3.0.0-alpha-0604 238 4/13/2023
3.0.0-alpha-0593 317 4/7/2023
3.0.0-alpha-0560 1,290 3/28/2023
3.0.0-alpha-0557 251 3/27/2023
3.0.0-alpha-0552 250 3/26/2023
3.0.0-alpha-0550 256 3/25/2023
3.0.0-alpha-0548 253 3/25/2023
3.0.0-alpha-0545 250 3/25/2023
3.0.0-alpha-0543 265 3/24/2023
3.0.0-alpha-0540 249 3/24/2023
3.0.0-alpha-0533 4,457 3/14/2023
3.0.0-alpha-0532 250 3/12/2023
3.0.0-alpha-0530 343 3/6/2023
3.0.0-alpha-0523 297 3/1/2023
3.0.0-alpha-0516 258 2/27/2023
3.0.0-alpha-0513 227 2/26/2023
3.0.0-alpha-0497 225 2/23/2023
3.0.0-alpha-0496 765 2/4/2023
3.0.0-alpha-0495 762 1/12/2023
3.0.0-alpha-0491 470 12/24/2022
3.0.0-alpha-0489 266 12/23/2022
3.0.0-alpha-0470 272 12/15/2022
3.0.0-alpha-0427 378 12/4/2022
3.0.0-alpha-0423 273 12/1/2022
3.0.0-alpha-0402 419 11/19/2022
3.0.0-alpha-0399 344 11/12/2022
3.0.0-alpha-0396 260 11/12/2022
3.0.0-alpha-0392 310 10/29/2022
3.0.0-alpha-0391 274 10/27/2022
3.0.0-alpha-0387 422 10/25/2022
3.0.0-alpha-0384 292 10/25/2022
3.0.0-alpha-0376 277 10/7/2022
3.0.0-alpha-0370 283 10/4/2022
3.0.0-alpha-0360 252 10/3/2022
3.0.0-alpha-0354 290 10/1/2022
3.0.0-alpha-0348 308 9/26/2022
3.0.0-alpha-0344 279 9/25/2022
3.0.0-alpha-0343 266 9/24/2022
3.0.0-alpha-0338 285 9/22/2022
3.0.0-alpha-0329 256 9/20/2022
3.0.0-alpha-0310 319 9/3/2022
3.0.0-alpha-0283 272 8/24/2022
3.0.0-alpha-0266 309 8/13/2022
3.0.0-alpha-0245 291 8/10/2022
3.0.0-alpha-0225 295 8/9/2022
3.0.0-alpha-0216 278 8/7/2022
3.0.0-alpha-0208 293 8/5/2022
3.0.0-alpha-0204 273 7/31/2022
3.0.0-alpha-0181 279 7/25/2022
3.0.0-alpha-0172 269 7/22/2022
3.0.0-alpha-0167 309 7/19/2022
3.0.0-alpha-0160 290 7/18/2022
3.0.0-alpha-0158 274 7/18/2022
3.0.0-alpha-0157 294 7/17/2022
3.0.0-alpha-0156 279 7/16/2022
3.0.0-alpha-0155 296 7/15/2022
3.0.0-alpha-0142 268 7/14/2022
3.0.0-alpha-0128 325 6/16/2022
3.0.0-alpha-0102 294 6/6/2022
3.0.0-alpha-0099 289 6/2/2022
3.0.0-alpha-0090 297 5/25/2022
3.0.0-alpha-0087 287 5/24/2022
3.0.0-alpha-0084 282 5/24/2022
3.0.0-alpha-0082 298 5/23/2022
3.0.0-alpha-0079 283 5/21/2022
3.0.0-alpha-0075 305 5/20/2022
1.1.1 8,800 3/3/2022
1.0.0 333 5/27/2023