QrOkGenerator 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package QrOkGenerator --version 1.0.0
                    


                    

                
NuGet\Install-Package QrOkGenerator -Version 1.0.0
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="QrOkGenerator" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="QrOkGenerator" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="QrOkGenerator" />
                    


                            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 QrOkGenerator --version 1.0.0
                    


                    

                
#r "nuget: QrOkGenerator, 1.0.0"
#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 QrOkGenerator@1.0.0
#: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=QrOkGenerator&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=QrOkGenerator&version=1.0.0
                    


                            Install as a Cake Tool

QrOk

QrOk is a free and simple QR code generator for C#. It is available as a NuGet package and also provides an optional Dependency Injection (DI) extension for easy integration into .NET applications.

Installation

You can install the package via NuGet:

Install-Package QrOkGenerator

If you want to use the Dependency Injection extension, install the additional package:

Install-Package QrOkGenerator.DependencyInjection

Usage

Basic usage

To generate and save a QR code as an image file, use the following code:

public static void ToFileExample()
{
    IQrOkBuilder.Builder
        .WithErrorCorrectionLevel(ErrorCorrectionLevel.L)
        .WithOutlineWidth(5)
        .WithSize(Size.M)
        .From("HELLO WORLD")
        .ToFile("filename.png", "<output-path>")
        .Build();
}

Using Dependency Injection

If you want to configure and use the QR code generator with IServiceCollection, install QrOkGenerator.DependencyInjection and configure it globally:

public static void ToFileUsingDIExample()
{
    var builder = Host.CreateApplicationBuilder();

    builder.Services.AddQrOkGenerator(settings =>
    {
        settings.Size = Size.S;
        settings.OutlineWidth = 10;
        settings.ErrorCorrectionLevel = ErrorCorrectionLevel.Q;
        settings.OutputPath = "<output-path>";
    });
}

Once registered, you can inject IQrOkBuilder into your classes:

public class ExampleClass
{
    private readonly IQrOkBuilder _qrBuilder;

    public ExampleClass(IQrOkBuilder qrBuilder)
    {
        _qrBuilder = qrBuilder;
    }

    public void ExampleMethod()
    {
        _qrBuilder.ToFile("filename.png");
    }
}

Benchmarks results

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on QrOkGenerator:

Package Downloads
QrOkGenerator.DependencyInjection

Dependency injection extension for the QrOk package.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 199 2/5/2025