Welcome to Avalonia.Samples. This is a collection of minimal samples, which should make it easy for everyone to get started with Avalonia. Each sample is focusing on only one aspect of Avalonia.
🗯 Get in touch with us
If you have feedback, questions or suggestions feel free to contact us via:
Or file a new bug-report or feature request in the Issues-section.
📂 Organization of the Samples
Every sample can be found in its own sub-folder and can run without any reference to another sample. Nevertheless we have a *.slnx-file which has all projects in one solution, if you are looking for a complete collection of samples.
| We migrated to the newer *.slnx-File format, which should be supported from all major IDEs. If it doesn’t work for you, please use the project-files inside the sub-directories. |
You can find the list of samples below. The samples are structured in different categories and difficulties. For better search results, each sample is also tagged with some buzz-words.
In every sample folder you will find a README-file, which describes the sample in detail and, if applicable, has links to further information and documentation.
🐣 Difficulties
Each sample is tagged with its difficulty. The degree of difficulty describes how much base-knowledge a user should have.
| 🔘 | Difficulty | Degree of knowledge |
|---|---|---|
🐣 |
Beginner |
A Beginner must not have any knowledge of Avalonia. Nevertheless some basic knowledge of |
🐥 |
Easy |
Some very basic knowledge of Avalonia is needed. |
🐔 |
Normal |
The user is somewhat experienced with Avalonia. |
🐉 |
Hard |
These samples are focusing on non-standard tasks, which most users will not need to know. |
✍️ Samples
💡 MVVM-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐣 Beginner |
MVVM, Model-View-ViewModel, ReactiveUI, INotifyPropertyChanged, XAML, Binding |
|
🐣 Beginner |
Command, ICommand, CommandParameter, MVVM, ReactiveCommand, async-await |
|
🐥 Easy |
Converter, Binding, MultiBinding, IValueConverter, IMultiValueConverter, MVVM, FuncValueConverter |
|
🐥 Easy |
MVVM, Data-Validation, Exception, Error, Error-Message, Binding |
DesktopIntegration-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐣 Beginner |
TrayIcon, ReactiveUI, Binding |
✒️ Drawing-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
Game, Canvas, Game Loop, MVVM |
|
🐔 Normal |
Graphics, MVVM |
🎞️ DataTemplate-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
DataTemplate, ToString, StringFormat, MVVM, ItemTemplate, ContentTemplate |
|
🐔 Normal |
FuncDataTemplate, DataTemplate, C#, Binding from code |
|
🐔 Normal |
IDataTemplate, DataTemplate, DataTemplateSelector |
🗺️ Routing / Navigation-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
ViewLocator, Routing, Wizard, Navigation, Page, MVVM |
🛠️ Custom Controls Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
Control, TemplatedControl, custom Control, reusable Control, AvaloniaProperty, StyledProperty, DirectProperty, ReadonlyProperty, Style, ControlTheme |
|
🐔 Normal |
Custom Control, Render, Hit-Testing, Custom Animations |
⚡ View Interaction Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
MVVM, Dialog, FileDialogs, TopLevel, Clipboard |
|
🐔 Normal |
MVVM, Dialog, FileDialogs, TopLevel, Clipboard, DialogManager, CommunityToolkit.Mvvm |
🧪️ Automated UI Testing
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐔 Normal |
XUnit, Headless, Automation, UI Testing |
|
🐔 Normal |
NUnit, Headless, Automation, UI Testing |
|
🐉 Hard |
XUnit, Appium, WinAppDriver, Automation, UI Testing |
🧑💻 Complete Apps
| Sample | Difficulty | Buzz-Words |
|---|---|---|
🐥 Easy |
ToDo-List, Complete App, MVVM, CommunityToolkit.MVVM, Source Generator, Styles, Commands |
|
🐥 Easy |
Music Store, Complete App, CommunityToolkit.MVVM, Mvvm.Messaging, Styles, ObservableProperty, Commands, iTunes Api |
🪛 Contribution
Is anything missing? Have you found an error? Have you found an outdated sample? Or do you have a great idea?
Fantastic! Your contribution is welcome.
| Before you start, make sure you have read the Code of Conduct. |
Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the Contributor Covenant Code of Conduct.
Issues and Feature Requests
If you file a new issue or feature request, please fill in the templates available. If you found an issue in an existing sample, please link the sample and, if possible, point us to what is wrong.
Pull Requests
| Pull requests may be discussed and probably not every pull request will be merged in the end. If you are not sure, please 🗯 Get in touch with us first. Anyway, every contribution is welcome. |
Fixing an existing sample
If you find that in an existing sample, that something is unclear or missing, you can update the sample and file a pull request. Spelling mistakes or wrong wording can also be changed in a pull request.
| If you change the difficulty or the buzz-words, remember to also update the main page. |
Adding a new sample
-
Add a new Project to the Solution:
src ► Avalonia.Samples ► Avalonia.Samples.sln -
In the root directory of the new sample add a
README-file. We highly suggest using a template which you can find here:-
AsciiDoc-Template: If you want to provide richer content, we suggest using the ascii-doc-template.
-
Markdown-Template: If you prefer not to use AsciiDoc, you can instead use the Markdown-template.
-