FluentSettings.Generator
1.0.7
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package FluentSettings.Generator --version 1.0.7
NuGet\Install-Package FluentSettings.Generator -Version 1.0.7
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="FluentSettings.Generator" Version="1.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluentSettings.Generator" Version="1.0.7" />
<PackageReference Include="FluentSettings.Generator" />
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 FluentSettings.Generator --version 1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FluentSettings.Generator, 1.0.7"
#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 FluentSettings.Generator@1.0.7
#: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=FluentSettings.Generator&version=1.0.7
#tool nuget:?package=FluentSettings.Generator&version=1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
FluentSettings.Generator
FluentSettings.Generator — a C# source generator for WinUI 3 that automates storing and retrieving app settings via ApplicationData.Current.LocalSettings.
What it does:
- Injects a base class LocalSettingsBase (inherits ObservableObject from CommunityToolkit.Mvvm) with helper methods: GetSetting<T>, GetSettingOrDefault<T>, SetSetting<T>, and GetSetting(key, Type).
- Injects a [LocalSetting] attribute you can place on partial properties to mark them for code generation.
- Generates for each marked property: • a partial getter that calls GetSetting<T>(key) • a partial setter that checks for change, calls SetSetting, raises OnPropertyChanged, and invokes optional partial hooks OnXxxChanging/OnXxxChanged
Installation: Run in your WinUI 3 project directory: dotnet add package FluentSettings.Generator --version 1.0.3
(The package will bring in CommunityToolkit.Mvvm >= 8.4.0 automatically.)
Usage:
- Create your settings class inheriting LocalSettingsBase:
public partial class AppSettings : LocalSettingsBase
{
[LocalSetting]
public partial string UserName { get; set; }
[LocalSetting(Key = "Age")]
public partial int UserAge { get; set; }
}
Build the project. Generated files:
- LocalSettingsBase.g.cs contains the base class.
- AppSettings.LocalSettings.g.cs contains the implementations for your properties.
In code:
var settings = new AppSettings();
settings.UserName = "Alice";
string name = settings.UserName; // reads from LocalSettings
Key points:
- Partial hooks: define partial methods OnUserNameChanging(old, new, ref bool cancel) or OnUserNameChanged(new) in your partial class to intervene.
- Duplicate key detection and diagnostic errors if two properties use the same key.
- Error if your partial class does not inherit LocalSettingsBase.
Repository: https://github.com/kirrishima/FluentSettings
NuGet: https://www.nuget.org/packages/FluentSettings.Generator
| Product | Versions 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-ios was computed. net6.0-maccatalyst was computed. 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. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| 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.
-
.NETStandard 2.0
- CommunityToolkit.Mvvm (>= 8.4.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.