chore: update and add Settings for samples

Author: DevTKSS

.vscode/settings.json

@@ -6,5 +6,5 @@
   },
   "files.associations": {
     "global.json": "jsonc"
-  }
-}
+  },
+}

README.md

@@ -3,7 +3,7 @@
 The samples in this Repository are meant to help other Developers, independent to their pre-knowledge, get an Idea of how to use the shown things.
 
 > [!TIP]
-> Check out the [Documentation](./doc/), for more a more detailed List and future coming Guides and Explanations.
+> Check out the [Documentation](./doc/articles/introduction.md), for more a more detailed List and future coming Guides and Explanations.
 
 ## Table of Contents
 
@@ -20,6 +20,7 @@ The samples in this Repository are meant to help other Developers, independent t
 ## Mvux Gallery
 
 Following list provides you a quick Overview, what you can find in the [Mvux Gallery](./src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery) App.
+The depending Documentation you can find [here](./doc/articles/MvuxGallery/Overview.md)
 
 ### Controls to be explored in this App
 

cSpell.json

@@ -0,0 +1,17 @@
+{
+    // cSpell configuration file
+    "version": "0.2",
+    "language": "en",
+    "words": [
+        // Add custom words here
+        "DevTKSS",
+        "Listboard"
+    ],
+    "ignoreWords": [],
+    "ignorePaths": [
+        // Add file paths to ignore here
+        "node_modules/**",
+        "dist/**",
+        "src/*"
+    ]
+}

doc/articles/MvuxGallery/Overview.md

@@ -4,21 +4,21 @@ uid: DevTKSS.Uno.SampleApps.MvuxGallery.Overview
 
 ## Mvux Gallery
 
-At the [Mvux Gallery](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery) you can explore the following features:
+At the [Mvux Gallery](../../../src/DevTKSS.Uno.Samples.MvuxGallery/) you can explore the following features:
 
 ### Controls
 
-- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml)
-- [DataTemplate centralized Resource Definition](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml)
-- [Card](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SimpleCardsPage.xaml)
-- [`ItemOverlayTemplate` DataTemplate](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml#L92-L123) (*Layout replicated from WinUI 3 Gallery*)
-- [Counter](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/CounterPage.xaml)
-- [Settings](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SettingsPage.xaml)
-- [FeedView + GridView](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/DashboardPage.xaml)
-- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml)
-- [DataTemplate centralized Resource Definition](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml)
-- [Card](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SimpleCardsPage.xaml)
-- [`ItemOverlayTemplate` DataTemplate](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml#L92-L123) (*Layout replicated from WinUI 3 Gallery*)
+- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml)
+- [DataTemplate centralized Resource Definition](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml)
+- [Card](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SimpleCardsPage.xaml)
+- [`ItemOverlayTemplate` DataTemplate](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml) (*Layout replicated from WinUI 3 Gallery*)
+- [Counter](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/CounterPage.xaml)
+- [Settings](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SettingsPage.xaml)
+- [FeedView + GridView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/DashboardPage.xaml)
+- [FeedView + ListView](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/ListboardPage.xaml)
+- [DataTemplate centralized Resource Definition](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml)
+- [Card](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/SimpleCardsPage.xaml)
+- [`ItemOverlayTemplate` DataTemplate](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Styles/Generic.xaml) (*Layout replicated from WinUI 3 Gallery*)
 
 ### Uno.Extensions
 
@@ -33,61 +33,61 @@ At the [Mvux Gallery](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxG
 - Navigation
   - via Xaml
     - NavigationView
-      - [MainPage.xaml](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/MainPage.xaml#L1-L50))
+      - [MainPage.xaml](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/Views/MainPage.xaml)
   - Via Model
     - (planned)
 
 - Hosting  
-  - [App.xaml.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs#L21-L91)
+  - [App.xaml.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs)
 
 - DependencyInjection
   - Service Registration
-    - [App.xaml.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs#L69-L74)
+    - [App.xaml.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs)
   - Service Definition
-    - [CodeSampleService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
-    - [ICodeSampleService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/ICodeSampleService.cs)
+    - [CodeSampleService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
+    - [ICodeSampleService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/ICodeSampleService.cs)
   - Data Model Definition
-    - [SampleCode.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/SampleCode.cs)
-    - [CodeSampleOption.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOption.cs)
-    - [CodeSampleOptionsConfiguration.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptionsConfiguration.cs)
+    - [SampleCode.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/SampleCode.cs)
+    - [CodeSampleOption.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOption.cs)
+    - [CodeSampleOptionsConfiguration.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptionsConfiguration.cs)
 
 - Serialization
   - JsonSerializerContext of each DataModel
-    - [CodeSampleOptionsContext](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptions.cs#L8-L11)
-    - [CodeSampleOptionsConfigurationContext](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptionsConfiguration.cs#L6-L9)
+    - [CodeSampleOptionsContext](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptions.cs)
+    - [CodeSampleOptionsConfigurationContext](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleOptionsConfiguration.cs)
 
 - Configuration
   - Data for Serialization  
-    - [appsettings.json](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/appsettings.json)
+    - [appsettings.json](../../../src/DevTKSS.Uno.Samples.MvuxGallery/appsettings.json)
 
 - Storage
   - Via Model
-    - [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs#L55-L141)
+    - [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
   - Via Service
-    - [CodeSampleService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
+    - [CodeSampleService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/CodeSamples/CodeSampleService.cs)
   - Via StorageExtension
     - Currently in private preview package
   - Via Uno.Extensions.Storage.IStorage Interface extension
     - added as PR to Uno.Extensions [#2734](https://github.com/unoplatform/uno.extensions/pull/2734)
 
 - Localization
   - **IStringLocalizer**
-    - Resources Dictionarys
-      - [en](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Strings/en/Resources.resw)
-      - [de](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Strings/en/Resources.resw)
+    - Resources Dictionaries
+      - [en](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Strings/en/)
+      - [de](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Strings/de/)
     - Binding current value in `IState<string>` and to corresponding View  
-      - [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs#L31)
-      - [ListboardModel.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs#L33)
-      - [MainModel.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/MainModel.cs#L21)
+      - [DashboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/DashboardModel.cs)
+      - [ListboardModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs)
+      - [MainModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/MainModel.cs)
       - CounterModel.cs  
     - Requesting localized Items via FeedView  
       - Service Definition  
-        - [GalleryImageService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageService.cs#L34-L66)
-        - [IGalleryImageService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/IGalleryImageService.cs#L6)
+        - [GalleryImageService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageService.cs)
+        - [IGalleryImageService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/IGalleryImageService.cs)
       - Data Model Definition  
-        - [GalleryImageModel.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageModel.cs)
+        - [GalleryImageModel.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageModel.cs)
   - **ILocalizationService**
-    - Requesing current culture  
-      - [GalleryImageService.cs](../../../src/DevTKSS.Uno.Samples/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageService.cs#L19-L30)
-    - Switching culture  
-      - (planned)  
+    - Requesting current culture
+      - [GalleryImageService.cs](../../../src/DevTKSS.Uno.Samples.MvuxGallery/Models/GalleryImages/GalleryImageService.cs)
+    - Switching culture
+      - (planned)

doc/docfx.json

@@ -20,7 +20,8 @@
           "**/*.{md,yml}"
         ],
         "exclude": [
-          "_site/**"
+          "_site/**",
+          "api/Uno.Resizetizer*.yml"
         ]
       }
     ],
@@ -52,4 +53,4 @@
       "pdf": false
     }
   }
-}
+}

src/DevTKSS.Uno.Samples.MvuxGallery/App.xaml.cs

@@ -62,10 +62,13 @@ protected async override void OnLaunched(LaunchActivatedEventArgs args)
                     configBuilder
                         .EmbeddedSource<App>()
                         .Section<AppConfig>()
-                        .Section<CodeSampleOptionsConfiguration>()
+
+                        .EmbeddedSource<App>("sampledata")
                         .Section<CodeSampleOptionsConfiguration>("DashboardSampleConfiguration")
                         .Section<CodeSampleOptionsConfiguration>("MainSampleConfiguration")
                         .Section<CodeSampleOptionsConfiguration>("ListboardSampleConfiguration")
+                        .Section<CodeSampleOptionsConfiguration>("CounterSampleConfiguration")
+                        .Section<CodeSampleOptionsConfiguration>("SimpleCardsSampleConfiguration")
                 )
                 // Enable localization (see appsettings.json for supported languages)
                 .UseLocalization()
@@ -89,7 +92,7 @@ protected async override void OnLaunched(LaunchActivatedEventArgs args)
         MainWindow.UseStudio();
 #endif
         MainWindow.SetWindowIcon();
-        
+
         Host = await builder.NavigateAsync<Shell>();
     }
 
@@ -113,10 +116,10 @@ private static void RegisterRoutes(IViewRegistry views, IRouteRegistry routes)
                             new ("Dashboard", View: views.FindByViewModel<DashboardModel>(),IsDefault: true),
                             new ("Listboard", View: views.FindByViewModel<ListboardModel>()),
                             new ("Counter", View: views.FindByViewModel<CounterModel>()),
-                           
+
                         ]
                     ),
-                    
+
                 ]
             )
         );

src/DevTKSS.Uno.Samples.MvuxGallery/Assets/Samples/CodeSample-Definition.cs.txt

@@ -0,0 +1,63 @@
+namespace DevTKSS.Uno.Samples.MvuxGallery.Models.CodeSamples;
+
+public record CodeSampleOptionsConfiguration
+{
+    public Dictionary<string, CodeSampleOption> Samples { get; init; } = new();
+}
+
+public record CodeSampleOption
+{
+    public string Description { get; init; } = string.Empty;
+    public string FilePath { get; init; } = string.Empty;
+    public List<(int Start, int End)> LineRanges { get; init; } = [];
+}
+
+namespace DevTKSS.Uno.Samples.MvuxGallery.Models.CodeSamples;
+
+[JsonSerializable(typeof(CodeSampleOptionsConfiguration))]
+public partial class CodeSampleOptionsConfigurationContext : JsonSerializerContext
+{
+}
+
+[JsonSerializable(typeof(CodeSampleOption))]
+public partial class CodeSampleOptionContext : JsonSerializerContext
+{
+}
+
+{
+  "ListboardSampleConfiguration": {
+    "FeedView + ListView XAML": {
+      "Description": "",
+      "FilePath": "Assets/Samples/FeedView-ListView-Sample.xaml.txt",
+      "LineRanges": []
+    },
+    "Use Service to load Data from Storage": {
+      "Description": "This sample shows how to use a service to load data from storage. The service is registered in the DI container and can be injected into the view model.",
+      "FilePath": "Assets/Samples/Listboard-SampleViaService.cs.txt",
+      "LineRanges": []
+    },
+    "DI Storage handling Service": {
+      "FilePath": "Assets/Samples/Listboard-StorageService.cs.txt",
+      "LineRanges": []
+    },
+    "Settings DataModel Definition": {
+      "Description": "While DataModels used to load Data via IOptions can not be fully immutable, using init instead of set allows us to set the properties only once, when the object is created.",
+      "FilePath": "Assets/Samples/CodeSample-Definition.cs.txt",
+      "LineRanges": [ 1, 13 ]
+    },
+    "Settings DataModel JsonContext": {
+      "Description": "Define the JsonSerializerContext to load the code sample options configuration from the appsettings.json file.",
+      "FilePath": "Assets/Samples/CodeSample-Definition.cs.txt",
+      "LineRanges": [ 15, 25 ]
+    },
+    "Settings Data in appsettings": {
+      "Description": "Settings to find storage Data, can easily be stored in appsettings.json, since we can update them via IWritableOptions.",
+      "FilePath": "Assets/Samples/CodeSample-Definition.cs.txt",
+      "LineRanges": []
+    },
+    "XAML DataTemplate": {
+      "Description": "The DataTemplate is used to define how the data is displayed in the ListView. The DataTemplate is showing a Card Control from Uno.Toolkit.UI and is definied in a ResourcesDictionary loaded via MergedResourcesDictionaries.",
+      "FilePath": "Assets/Samples/Card-GalleryImage.DataTemplate.xaml.txt",
+      "LineRanges": []
+    },
+  },

src/DevTKSS.Uno.Samples.MvuxGallery/Assets/Samples/CodeSampleService.cs.txt

@@ -0,0 +1,52 @@
+namespace DevTKSS.Uno.Samples.MvuxGallery.Models.CodeSamples;
+
+
+
+public record CodeSampleService : ICodeSampleService
+{
+    public CodeSampleService(
+    IOptions<CodeSampleOptionsConfiguration> options,
+    ILogger<CodeSampleService> logger,
+    IStorage storage)
+    {
+        _options = options.Value;
+        _logger = logger;
+        _storage = storage;
+    }
+
+    private readonly IStorage _storage;
+    private readonly ILogger<CodeSampleService> _logger;
+    private readonly CodeSampleOptionsConfiguration _options;
+
+    /// <summary>
+    /// Get a static Collection of Values for <see cref="CodeSampleOptions"/>
+    /// </summary>
+    /// <param name="ct">
+    /// A CancellationToken to make it compileable
+    /// <remarks>
+    /// since `ListFeed.Async` requires a CancellationToken even if Uno Documentation remarks this parameter to be optional.<br/>
+    /// <see href="https://learn.microsoft.com/en-us/dotnet/csharp/misc/cs0411?f1url=%3FappId%3Droslyn%26k%3Dk(CS0411)">CS0411</see><br/>
+    /// <br/>
+    /// adding then the type string or IImmutableList<string> to the ListFeed like `ListFeed<string>.Async(...)`,
+    /// or to the Async Extension itself like `ListFeed.Async<IImutableList<string>` results in a type mismatch.<br/>
+    /// <see href="https://learn.microsoft.com/en-us/dotnet/csharp/misc/cs1503?f1url=%3FappId%3Droslyn%26k%3Dk(CS1503)">CS1503</see>
+    /// </remarks>
+    /// <returns>An awaitable <see cref="ValueTask{TResult}"/> providing a <see cref="ImmutableList{T}"/> of <see langword="string"/> with the Sample Names to select from</returns>
+    public async ValueTask<IImmutableList<string>> GetCodeSampleOptionsAsync(CancellationToken ct = default)
+    {
+        await Task.Delay(1);
+        return _options.Samples.Keys.ToImmutableList(); 
+    }
+
+    public async ValueTask<string> GetCodeSampleAsync(string sampleID, CancellationToken ct = default)
+    {
+        if (_options.Samples.TryGetValue(sampleID, out CodeSampleOption? sampleOption))
+        {
+            return await _storage.ReadLinesFromPackageFile(sampleOption.FilePath, sampleOption.LineRanges);
+        }
+
+        _logger.LogWarning("Code sample with ID {sampleID} not found", sampleID);
+        return string.Empty;
+    }
+
+}