= Avalonia image:_docs/_Assets/Logo.svg[link=https://www.avaloniaui.net] Samples
ifndef::env-github[]
:toc: left
endif::[]
ifdef::env-github[]
:toc: auto
// :toc-placement!:
endif::[]
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
ifndef::env-github[]
:icons: font
endif::[]
// toc::[]
Welcome to Avalonia.Samples. This is a collection of minimal samples, which should make it easy for everyone to get started with https://www.avaloniaui.net[Avalonia^]. Each sample is focusing on only one aspect of Avalonia.
[#get-in-touch]
== 🗯 Get in touch with us
If you have feedback, questions or suggestions, feel free to contact us via:
image:https://raw.githubusercontent.com/Patrolavia/telegram-badge/master/chat.svg[link=https://t.me/Avalonia]
image:https://img.shields.io/badge/https%3A%2F%2Fimg.shields.io%2Fbadge%2Fgithub-discussions-blue%3Flogo%3Dgithub?style=flat&label=github&color=darkgreen&link=https%3A%2F%2Fgithub.com%2FAvaloniaUI%2FAvalonia.Samples%2Fdiscussions[link=https://github.com/AvaloniaUI/Avalonia.Samples/discussions]
Or file a new bug-report or feature request in the https://github.com/AvaloniaUI/Avalonia.Samples/issues[`Issues`]-section.
[#_organization_of_the_samples]
== 📂 Organization of the Samples
Every sample can be found in its own subfolder 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.
NOTE: 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 subdirectories.
You can find the list of samples <<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]
=== 🐣 Difficulties
Each sample is tagged with its difficulty. The degree of difficulty describes how much base-knowledge a user should have.
[cols="1,1,2"]
|===
| 🔘 | Difficulty | Degree of knowledge
| 🐣 | Beginner
| A Beginner must not have any knowledge of Avalonia. Nevertheless, some basic knowledge of C#, X(A)ML and your IDE is mandatory.
| 🐥 | 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]
== ✍️ Samples
////
Copy the below for a new entry in the sample-tables and replace the text in << >> with your content.
| link:src/Avalonia.Samples/<<The_Chapter>>/<>[<>]
| <>
| <>
////
[#_mvvm_samples]
=== 💡 MVVM-Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/MVVM/BasicMvvmSample[Basic MVVM Sample]
| 🐣 Beginner
| MVVM, Model-View-ViewModel, ReactiveUI, INotifyPropertyChanged, XAML, Binding
| link:src/Avalonia.Samples/MVVM/CommandSample[Commands Sample]
| 🐣 Beginner
| Command, ICommand, CommandParameter, MVVM, ReactiveCommand, async-await
| link:src/Avalonia.Samples/MVVM/ValueConversionSample[ValueConverter Sample]
| 🐥 Easy
| Converter, Binding, MultiBinding, IValueConverter, IMultiValueConverter, MVVM, FuncValueConverter
| link:src/Avalonia.Samples/MVVM/ValidationSample[Validation Sample]
| 🐥 Easy
| MVVM, Data-Validation, Exception, Error, Error-Message, Binding
|===
=== DesktopIntegration-Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/DesktopIntegration/TrayIcon[Tray Icon Sample]
| 🐣 Beginner
| TrayIcon, ReactiveUI, Binding
|===
[#_drawing_samples]
=== ✒️ Drawing-Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/Drawing/BattleCity[BattleCity Game Sample]
| 🐔 Normal
| Game, Canvas, Game Loop, MVVM
| link:src/Avalonia.Samples/Drawing/RectPainter[Rect Painter Sample]
| 🐔 Normal
| Graphics, MVVM
|===
[#_datatemplate_samples]
=== 🎞️ DataTemplate-Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/DataTemplates/BasicDataTemplateSample[Basic DataTemplate Sample]
| 🐔 Normal
| DataTemplate, ToString, StringFormat, MVVM, ItemTemplate, ContentTemplate
| link:src/Avalonia.Samples/DataTemplates/FuncDataTemplateSample[FuncDataTemplate Sample]
| 🐔 Normal
| FuncDataTemplate, DataTemplate, C#, Binding from code
| link:src/Avalonia.Samples/DataTemplates/IDataTemplateSample[Implementing IDataTemplate Sample]
| 🐔 Normal
| IDataTemplate, DataTemplate, DataTemplateSelector
|===
[#_routing_navigation_samples]
=== 🗺️ Routing / Navigation-Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/Routing/BasicViewLocatorSample[Basic ViewLocator Sample]
| 🐔 Normal
| ViewLocator, Routing, Wizard, Navigation, Page, MVVM
|===
[#_custom_controls_samples]
=== 🛠️ Custom Controls Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/CustomControls/RatingControlSample[RatingControl Sample]
| 🐔 Normal
| Control, TemplatedControl, custom Control, reusable Control, AvaloniaProperty, StyledProperty, DirectProperty, ReadonlyProperty, Style, ControlTheme
| link:src/Avalonia.Samples/CustomControls/SnowflakesControlSample[SnowflakesControl Sample]
| 🐔 Normal
| Custom Control, Render, Hit-Testing, Custom Animations
|===
[#_view_interaction_samples]
=== ⚡ View Interaction Samples
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/ViewInteraction/MvvmDialogSample[Mvvm Dialog Sample]
| 🐔 Normal
| MVVM, Dialog, FileDialogs, TopLevel, Clipboard
| link:src/Avalonia.Samples/ViewInteraction/DialogManagerSample[Dialog Manager Sample]
| 🐔 Normal
| MVVM, Dialog, FileDialogs, TopLevel, Clipboard, DialogManager, CommunityToolkit.Mvvm
|===
[#_automated_ui_testing]
=== 🧪️ Automated UI Testing
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/Testing/TestableApp.Headless.XUnit[Testing with Headless XUnit]
| 🐔 Normal
| XUnit, Headless, Automation, UI Testing
| link:src/Avalonia.Samples/Testing/TestableApp.Headless.NUnit[Testing with Headless NUnit]
| 🐔 Normal
| NUnit, Headless, Automation, UI Testing
| link:src/Avalonia.Samples/Testing/TestableApp.Appium[Testing with Appium]
| 🐉 Hard
| XUnit, Appium, WinAppDriver, Automation, UI Testing
|===
[#_complete_apps]
[complete-apps]
=== 🧑💻 Complete Apps
[cols="25h,25,50"]
|===
| Sample | Difficulty | Buzz-Words
| link:src/Avalonia.Samples/CompleteApps/SimpleToDoList[Simple ToDo-List]
| 🐥 Easy
| ToDo-List, Complete App, MVVM, CommunityToolkit.MVVM, Source Generator, Styles, Commands
| link:src/Avalonia.Samples/CompleteApps/Avalonia.MusicStore[Music Store App]
| 🐥 Easy
| Music Store, Complete App, CommunityToolkit.MVVM, Mvvm.Messaging, Styles, ObservableProperty, Commands, iTunes Api
| link:src/Avalonia.Samples/FSharp/CompleteApps/MusicStore[Music Store App (F#)]
| 🐥 Easy
| F#, Music Store, Complete App, CommunityToolkit.MVVM, Mvvm.Messaging, Styles, ObservableProperty, iTunes Api, Functional Programming
| link:src/Avalonia.Samples/CompleteApps/AdvancedToDoList[Advanced ToDo-List]
| 🐉 Hard
| Todo-List, Cross-Platform, WebAssembly (WASM), SQLite, Service Pattern, Dependency Injection, MVVM Pattern, IndexedDB, Unit Testing, Headless Testing, Persistent Storage, Controls-Library
|===
[#_contribution]
== 🪛 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.
NOTE: 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 https://dotnetfoundation.org/code-of-conduct[Contributor Covenant Code of Conduct].
[#_issues_and_feature_requests]
=== 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
NOTE: Pull requests may be discussed and probably not every pull request will be merged in the end. If you are not sure, please <> first. Anyway, every contribution is welcome.
[#_fixing_an_existing_sample]
==== Fixing an existing sample
If you find that in an existing sample 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.
IMPORTANT: If you change the difficulty or the buzz-words, remember to also update the main page.
[#_adding_a_new_sample]
==== 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:
.. link:/_docs/AsciiDoc-Template/[AsciiDoc-Template]: If you want to provide richer content, we suggest using the https://asciidoc.org[ascii-doc]-template.
.. link:/_docs/Markdown-Template/[Markdown-Template]: If you prefer not to use AsciiDoc, you can instead use the Markdown-template.
// Comment this in for next year's Hacktoberfest
////
=== 🎃 Hacktoberfest 2023
We are participating in https://hacktoberfest.com[[Hacktoberfest 2023]]. If you submit a valid pull request within this month, we will add the HACKTOBERFEST-ACCEPTED label to your PR. Read more about it and how to participate https://hacktoberfest.com/participation/[[here\]].
Valid PRs are::
- Adding a new sample
- Fixing an existing sample
- Improving an existing sample
- Doing an overall spell-check (Not just changing a random word!)
WARNING: Spam or invalid PRs will be marked as invalid. If you are unsure if your PR will be accepted for Hacktoberfest, you can ask us here or in the image:https://raw.githubusercontent.com/Patrolavia/telegram-badge/master/chat.svg[link=https://t.me/Avalonia].
🎃 Happy coding 🎃
////
