Avalonia README

The project's README from github.com/AvaloniaUI/Avalonia. As one markdown file: README.md.

Star_Banner@3x Hero

Build Status License NuGet downloads

📖 About

Avalonia is a cross-platform UI framework for dotnet, providing a flexible styling system and supporting a wide range of platforms such as Windows, macOS, Linux, iOS, Android and WebAssembly. Avalonia is mature and production ready and is used by companies, including Schneider Electric, Unity, JetBrains and GitHub.

Considered by many to be the spiritual successor to WPF, Avalonia UI provides a familiar, modern development experience for XAML developers creating cross-platform applications. While Avalonia UI is similar to WPF, it isn't a 1:1 copy, and you'll find plenty of improvements.

For those seeking a cross-platform WPF, we have created Avalonia XPF, enabling WPF applications to run on macOS and Linux with little to no code changes. Avalonia XPF is a commercial product and is licensed per-app, per-platform.

Blog

To see the latest announcements and read about the state of Avalonia, check out the Avalonia UI Blog.

Sponsorship

Avalonia development is supported by the generous sponsorship of Devolutions.

Devolutions Logo

🚀 Getting Started

See our Get Started guide to begin developing apps with Avalonia UI.

Visual Studio Code

The Avalonia for Code extension gives you everything you need to build cross-platform .NET apps. XAML previewing, code completion, diagnostics, and code navigation, all inside the world's most popular editor. It's the fastest way to get started with Avalonia.

Visual Studio 2022 & 2026

The Avalonia Visual Studio Extension contains project and control templates, a live XAML previewer, code completion, and full diagnostics directly into Visual Studio.

JetBrains Rider

JetBrains Rider supports for Avalonia.

Code completion, inspections and refactorings are supported out of the box. To enable previewing XAML, you will require a 3rd party, community-maintained extension: https://plugins.jetbrains.com/plugins/dev/14839 to plugin repositories and install AvaloniaRider plugin.

Avalonia Packages

Avalonia is delivered via NuGet package manager. You can find the packages here: https://www.nuget.org/packages/Avalonia/

Use these commands in the Package Manager console to install Avalonia manually:

Install-Package Avalonia
Install-Package Avalonia.Desktop

Bleeding Edge Builds

We also have a nightly build which tracks the current state of master. Although these packages are less stable than the release on NuGet.org, you'll get all the latest features and bugfixes right away and many of our users actually prefer this feed!

Learning

Documentation

Documentation can be found at https://docs.avaloniaui.net.

Tutorials

We also have a tutorial over there for newcomers.

Samples

We have a range of samples to help you get started.

Breaking Changes

You can also see what breaking changes between Avalonia 11 and Avalonia 12.

Building and Using

See the build instructions here.

Contributing

This project exists thanks to all the people who contribute. Please read the contribution guidelines before submitting a pull request.

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 Code of Conduct.

Security

If you discover a security vulnerability in any of our SDKs, tools, services, or repositories, please help us keep the community safe by reporting it responsibly.

You can report security vulnerabilities by emailing [email protected].

Please avoid disclosing the issue publicly until we have had a reasonable amount of time to investigate and release a patch or mitigation. We review all legitimate reports and will work with you to quickly resolve the issue.

Please note that Avalonia does not operate a bug bounty programme.

Licence

Avalonia is licenced under the MIT licence.

XPF - cross-platform WPF

Unleash the full potential of your existing WPF apps with our cross-platform UI framework, enabling WPF apps to run on macOS and Linux without requiring expensive and risky rewrites. GH_Banner

Avalonia (AvaloniaUI/Avalonia)

avalonia
Searching Database…

31.7K ·GitHub
Avalonia
What is this?Avalonia is a cross-platform UI framework for .NET: you write apps in C# and XAML, and they run on Windows, macOS, Linux, iOS, Android and WebAssembly.
Is this a full framework or more of a widget library?A full UI framework: you write C# with XAML markup, get a flexible styling system, and structure apps MVVM-style.
How do I add it to a project?Avalonia is delivered as NuGet packages you add to your .NET project; the README lists Package Manager console commands for manual install.
Which editors and IDEs support it — do I get XAML previewing everywhere?VS Code and Visual Studio 2022 & 2026 have Avalonia extensions with XAML previewing, completion and diagnostics; Rider supports Avalonia out of the box, but previewing there needs the community AvaloniaRider plugin.
If I already know WPF, will that experience carry over?Largely — Avalonia is considered the spiritual successor to WPF and feels familiar to XAML developers, but it isn't a 1:1 copy: expect plenty of improvements and some differences.
Is the whole thing free, or is there a paid piece?The framework itself is free under the MIT licence. The paid piece is Avalonia XPF, which runs existing WPF apps on macOS and Linux with little to no code changes — it's licensed per-app, per-platform.
Is Avalonia production ready — who's using it for real apps?Yes — the README calls it mature and production ready; companies using it include Schneider Electric, Unity, JetBrains and GitHub.
Is there a way to try the newest features before a stable release?There's a nightly build feed tracking master: less stable than NuGet.org releases, but you get the latest features and bugfixes right away, and many users prefer it.
Where can I see real example code before committing to it?The repo links a range of sample apps to help you get started, plus documentation and a tutorial for newcomers.
What are similar projects?uno, SteamTools, maui, flutter, MonoGame, aivchatdemo, quiver-launcher, CodeHub
Which topics is it in?app-framework, xamarin, xaml, avalonia, mvvm, ui-framework, c-sharp, dotnet, c#, csharp, wasm, browser
Creator
AvaloniaUI
Size
233.4 MB
Stars
31.7K
Updated
CommitOct 16Release12.1.4Oct 09
Age
12y
Commits · 90 Days