Avalonia 
Samples
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 *.sln-File which has all projects in one solution, if you are looking for a complete collection of samples.
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 itโs 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 |
|---|---|---|
MVVM, Model-View-ViewModel, ReactiveUI, INotifyPropertyChanged, XAML, Binding |
||
Command, ICommand, CommandParameter, MVVM, ReactiveCommand, async-await |
||
Converter, Binding, MultiBinding, IValueConverter, IMultiValueConverter, MVVM |
||
MVVM, Data-Validation, Exception, Error, Error-Message, Binding |
โ๏ธ Drawing-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
Game, Canvas, Game Loop, MVVM |
๐๏ธ DataTemplate-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
DataTemplate, ToString, StringFormat, MVVM, ItemTemplate, ContentTemplate |
||
FuncDataTemplate, DataTemplate, C#, Binding from code |
||
IDataTemplate, DataTemplate, DataTemplateSelector |
๐บ๏ธ Routing / Navigation-Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
ViewLocator, Routing, Wizard, Navigation, Page, MVVM |
๐ ๏ธ Custom Controls Samples
| Sample | Difficulty | Buzz-Words |
|---|---|---|
Control, TemplatedControl, custom Control, reusable Control, AvaloniaProperty, StyledProperty, DirectProperty, ReadonlyProperty, Style, ControlTheme |
๐ช 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 the 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 |
Fixing an existing sample
If you find that in an existing sample, that something is unclear or missing, you can update this sample and file a pull request. Also spelling mistakes or wrong wording can be changed and a pull request can be send.
|
|
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 to use the template which you can find here:-
AsciiDoc-Template: If you want to provide richer content, we suggest to use the ascii-doc-template.
-
Markdown-Template: If you donโt like option a), you can use also the Markdown-template.
-
