Ursa UI Library

The QrCode control is a self-contained component included in Ursa.Avalonia to provide QR code rendering without requiring the full Avalonia.Labs dependency.

Important Maintenance Note: This control is a local copy of the implementation from Avalonia.Labs. It may not receive the same updates or bug fixes as the upstream project. If you require the latest features or specific fixes from the upstream source, it is recommended to use the official Avalonia.Labs NuGet package instead of this local version.

Ursa provides specialized extensions for popular Avalonia frameworks:

• Prism Extension: Use Irihi.Ursa.PrismExtension to integrate Ursa with Prism.Avalonia. This package provides dialog-related services that allow you to use Ursa dialogs in a Prism-idiomatic way.
• ReactiveUI Extension: Use Irihi.Ursa.ReactiveUIExtension to integrate with ReactiveUI.Avalonia. This package provides ReactiveUI-compatible versions of UrsaWindow and UrsaView.

After installing the packages, you must include the styles in your App.xaml (or the Application definition of your project). You need to define the semi namespace and add both SemiTheme and UrsaSemiTheme to the Application.Styles collection.

<Application...
    xmlns:semi="https://irihi.tech/semi"
    ....>

    <Application.Styles>
        <semi:SemiTheme Locale="zh-CN" />
        <semi:UrsaSemiTheme Locale="zh-CN"/>
    </Application.Styles>
    ...

If you prefer to use the official implementation from Avalonia.Labs rather than the local copy provided by Ursa, follow these steps:

1. Add the Avalonia.Labs package to your project via NuGet.
2. Remove the local QrCode control from your project to avoid naming conflicts or duplicate implementations.

To use Ursa controls in your Avalonia application, you must install the core Ursa package and a compatible theme package. Ursa.Themes.Semi (inspired by Semi Design) is the recommended theme for Ursa controls.

1. Install the core Ursa package.
2. Install Semi.Avalonia and Irihi.Ursa.Themes.Semi to provide the visual styles.

dotnet add package Irihi.Ursa
dotnet add package Semi.Avalonia
dotnet add package Irihi.Ursa.Themes.Semi

To use Ursa controls in your Avalonia application, add the core Irihi.Ursa NuGet package to your project.

dotnet add package Irihi.Ursa

Ursa controls require a theme package to render correctly. Ursa.Themes.Semi is a theme inspired by Semi Design.

To set it up:

1. Add the Semi.Avalonia and Irihi.Ursa.Themes.Semi NuGet packages.
2. Include SemiTheme and UrsaSemiTheme in your App.axaml (or Application.Styles).

dotnet add package Semi.Avalonia
dotnet add package Irihi.Ursa.Themes.Semi

<Application...
    xmlns:semi="https://irihi.tech/semi"
    ....>

    <Application.Styles>
        <semi:SemiTheme Locale="zh-CN" />
        <semi:UrsaSemiTheme Locale="zh-CN"/>
    </Application.Styles>

Ursa is compatible with Avalonia versions 11.1.x through 11.3.x.

Note: Ursa explicitly does not support Avalonia version 11.2.0.

Once the library and themes are installed, you can use Ursa controls by declaring the https://irihi.tech/ursa XML namespace in your XAML files.

<Window
    ...
    xmlns:u="https://irihi.tech/ursa"
    ...>
    <StackPanel Margin="20">
        <u:TagInput />
    </StackPanel>
</Window>

To use Ursa controls in your windows or user controls, declare the Ursa namespace (typically using the prefix u) and then use the controls as standard Avalonia elements.

<Window
    ...
    xmlns:u="https://irihi.tech/ursa"
    ...>
    <StackPanel Margin="20">
        <u:TagInput />
    </StackPanel>
</Window>