Skip to content

Installation ​

INFO

When this page was written, the latest Avalonia version was 11.2.0-beta1 with SukiUI version 6.0.0-beta8

SukiUI can be installed in two ways:

Prepare your application ​

The following picture shows packages already installed with the default Avalonia Template:

In these packages, Avalonia.Themes.Fluent will no longer be necessary and can be removed.

TIP

About Avalonia Template: Set up an editor

Install latest SukiUI package ​

The Nuget installation is suitable for most users, but if you want to use the latest build, you can download the dll from Github Action after the automatic build.

Via Nuget ​

dotnet add package SukiUI --version 6.0.0

You're done !

TIP

Visit SukiUI on Nuget for more information

Optional ConditionalXAML helpers ​

SukiUI's core package does not include the ConditionalXAML helpers or their System.Linq.Dynamic.Core dependency. If your application uses If or InlineSharp, install the optional package:

bash
dotnet add package SukiUI.ConditionalXAML

Then add a project or package reference to SukiUI.ConditionalXAML. The helper namespace remains unchanged:

xml
xmlns:X="clr-namespace:SukiUI.Helpers.ConditionalXAML;assembly=SukiUI.ConditionalXAML"

Optional ColorPicker support ​

SukiUI's core package does not include the Avalonia.Controls.ColorPicker package. If your application uses ColorPicker and the SukiUI ColorPicker theme, install the optional package:

bash
dotnet add package SukiUI.ColorPicker

Then include the Avalonia Fluent ColorPicker styles and SukiUI ColorPicker styles after SukiTheme in App.axaml:

xml
<Application.Styles>
    <StyleInclude Source="avares://Avalonia.Controls.ColorPicker/Themes/Fluent/Fluent.xaml" />
    <suki:SukiTheme />
    <StyleInclude Source="avares://SukiUI.ColorPicker/Theme/Index.axaml" />
</Application.Styles>

Optional DataGrid support ​

SukiUI's core package does not include the deprecated Avalonia.Controls.DataGrid package. If your application uses DataGrid and the SukiUI DataGrid theme, install the optional package:

bash
dotnet add package SukiUI.DataGrid

Then include its styles after SukiTheme in App.axaml:

xml
<Application.Styles>
    <suki:SukiTheme />
    <StyleInclude Source="avares://SukiUI.DataGrid/Theme/Index.axaml" />
</Application.Styles>

Via Github Action ​

Github Action Guide
  1. Visit SukiUI CI

  2. Select the latest workflow

  3. Download the artifact

  4. Add reference

  5. Select SukiUI.dll you downloaded

TIP

The package list should be: