HotCoffee.Maui.Extensions 1.0.0

NuGet Package: HotCoffee.Maui.Extensions

Overview

HotCoffee.Maui.Extensions is a powerful and easy-to-use library for .NET applications that simplifies [insert functionality, e.g., configuration, appconfig.json, etc.]. With a focus on configurability and usability, HotCoffee.Maui.Extensions allows developers to quickly integrate advanced features into their projects without hassle.

Features

• Simple API: Intuitive methods that reduce boilerplate code.
• High Performance: Optimized for speed and efficiency.
• Cross-Platform: Compatible with .NET Core, MAUI.
• Well-Documented: Comprehensive documentation and examples to get you started quickly.

Installation

You can install HotCoffee.Maui.Extensions via NuGet Package Manager Console:

Install-Package HotCoffee.Maui.Extensions

Or by using the .NET CLI:

dotnet add package HotCoffee.Maui.Extensions

Usage

Here's a quick example to demonstrate how to use HotCoffee.Maui.Extensions in your application:

1. Import the Namespace

   Make sure to include the library in your file:

   using HotCoffee.Maui.Extensions;
   

2. Create appconfig.json file in your project folder directory

   Make sure to create the appconfig.json file in you project directory. Below is a simple example where you need to create.

3. Set build action as Embedded resource of appconfig.json file Below is a screenshot example where you create and reside your appconfig.json file in your project structure.

   Note : Its should be created under project root directory.

4. Set some example values in the appconfig.json file to get the value into C# classes via IConfiguration dependency Filename should be save as appconfig.json

   {
       "BaseUrl": 
       {
            "DefaultUrl": "https://api.exampleproject.com/api/" //Example API Base Url
       }
   }
   

5. Initialize and Use the Library

   Below is a simple example of how to use HotCoffee.Maui.Extensions to config the appconfig.json file to consume the configurable the values into the app:

    public static class MauiProgram
    {
        public static MauiApp CreateMauiApp()
        {
            var builder = MauiApp.CreateBuilder();
            builder
                .UseMauiApp<App>()
                .ConfigureAppConfiguration(typeof(MauiProgram) , "appconfig.json")
                .ConfigureFonts(fonts =>
                {
                    fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
                    fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
                });
            return builder.Build();
        }
    }
   

6. Consume the appconfig.json values into the code Below is the example code how we can use the appconfig.json values into our c# class using dependency injection of type IConfiguration just like below example.

   1. Import the Namespace Make sure to include the library in c# code file:

   using Microsoft.Extensions.Configuration;
   

   2. Inject the IConfiguration dependency in your C# class constructor Below is the sample example code how you can consume the appconfig.json files values into your C# code classes.

    public partial class MainPage : ContentPage
    {
        public MainPage(IConfiguration configuration)
        {
            InitializeComponent();
            var baseUrl = (string)configuration["BaseUrl:url"]!;
   
            //Here we can print the values for showing the output in console.
            Console.WriteLine(baseUrl);
        }
    }
   

7. Final output should look like below

   Output : https://api.exampleproject.com/api/

Documentation

For detailed information on all features, configurations, and advanced usage, please refer to the official documentation.

Support

If you encounter any issues or have questions, please open an issue on our GitHub repository or contact on our email.