Documentation
API Reference
IDE Support
JetBrains Rider
The JetBrains Rider IDE has built-in support for Avalonia XAML starting in 2020.3 including first-class support for Avalonia-specific XAML features and custom code inspections.
Rider does not yet provide a visual designer, but this is in development. See the GitHub project for more information and instructions on how to install.
Visual Studio
Avalonia Visual Studio Extension
The Avalonia for Visual Studio extension includes a XAML designer which can be used to show a live preview of the XAML as you're writing it. With the Avalonia for Visual Studio extension installed, double click on an Avalonia XAML file to open it.
ReSharper for Visual Studio
For Visual Studio and ReSharper users, ReSharper 2020.3 introduces built-in code analysis, code completion, navigation, and find usages.
If your XAML is in a library, Avalonia needs an executable application in order to be able to preview it. Select an executable project from the dropdown on the top right of the designer. Once your project is built, editing the XAML in the editor will cause the preview to update automatically.
In some cases, due to bugs/limitations in Visual Studio, the Avalonia XAML designer is not shown and instead the WPF designer gets shown. If your XAML file is showing a lot of errors, try right-clicking the file then selecting "Open With..." → "Avalonia XAML Editor".
Design-Time Properties
There are a number of properties that can be applied to your controls which will take effect only at design-time. To use these you must add a namespace to your XAML file:
1
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
Copied!
With the namespace added, the following design-time properties become available:
d:DesignWidth and d:DesignHeight
The
d:DesignWidth and d:DesignHeight properties apply a width and height to the control being previewed.1
<Window xmlns="https://github.com/avaloniaui"
2
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
3
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
4
d:DesignWidth="800" d:DesignHeight="450"
5
x:Class="AvaloniaApplication1.MainWindow">
6
Welcome to Avalonia!
7
</Window>
Copied!
d:DataContext
The
d:DataContext property applies a DataContext only at design-time. It is recommended that you use this property in conjunction with the {x:Static} directive to reference a static property in one of your assemblies:1
<Window xmlns="https://github.com/avaloniaui"
2
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
3
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
4
xmlns:dd="clr-namespace:My.Namespace;assembly=MyAssembly"
5
d:DataContext="{x:Static dd:DesignData.ExampleViewModel}"
6
x:Class="AvaloniaApplication1.MainWindow">
7
Welcome to Avalonia!
8
</Window>
Copied!
1
namespace My.Namespace
2
{
3
public static class DesignData
4
{
5
public static MyViewModel ExampleViewModel { get; } = new MyViewModel
6
{
7
// View Model initialization here.
8
};
9
}
10
}
Copied!
Diagnosing Errors
If you're having problems, try enabling verbose logging. To do this:
- Select the to "Tools" → "Options" menu in Visual Studio
- Select "Avalonia XAML Editor" from the list
- Select "Verbose" under "Minimum Log Verbosity"
Logs will be displayed in the Visual Studio Output window. Select "Show Output From: Avalonia Diagnostics".
Troubleshooting & FAQ
Visual Studio doesn't show the Avalonia previewer
Sometimes Visual Studio opens the
XAML-file with the editor for WPF instead of Avalonia. Normally this issue is solved if you close the wrong shown document and open it again.If that didn't help you can also right click on the file and select
[Open With ...]. In the opened dialog select [Avalonia XAML Editor].My preview is empty
If your preview is not shown correctly try to (re-)build the project or solution. The previewer needs a valid build in order to work correctly.
Moreover if you have more than one project in your solution, you may need to select the project which should be used to render the preview. This can be done with the drop-down shown below.
Shows how to select the project used to render the preview
Last modified 15d ago