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)

Searching Database…

31.7K ·GitHub
这是什么?Avalonia 是一个面向 .NET 的跨平台 UI 框架:你用 C# 和 XAML 编写应用,它们可以运行在 Windows、macOS、Linux、iOS、Android 和 WebAssembly 上。
它是一个完整的框架,还是更像一个控件库?是一个完整的 UI 框架:你用 C# 配合 XAML 标记来编写代码,拥有一套灵活的样式系统,并按照 MVVM 模式来组织应用结构。
我怎么把它添加到项目里?Avalonia 以 NuGet 包的形式提供,添加到你的 .NET 项目即可;README 中列出了用于手动安装的 Package Manager 控制台命令。
哪些编辑器和 IDE 支持它——我在哪里都能预览 XAML 吗?VS Code 和 Visual Studio 2022 与 2026 都有 Avalonia 扩展,提供 XAML 预览、自动补全和诊断功能;Rider 原生支持 Avalonia,但要在 Rider 里预览,需要安装社区开发的 AvaloniaRider 插件。
如果我已经会 WPF,那些经验能直接用上吗?大部分可以——Avalonia 被视为 WPF 的精神续作,XAML 开发者用起来会很熟悉,但它并不是 1:1 的复制品:会有一大堆改进,也存在一些差异。
它是完全免费的吗,还是有付费的部分?框架本身基于 MIT 许可证免费。付费的部分是 Avalonia XPF,它能让现有的 WPF 应用几乎不改代码就运行在 macOS 和 Linux 上——按应用、按平台授权收费。
Avalonia 能用于正式生产环境吗——有哪些公司在实际用它做应用?可以——README 中称它已经成熟、可用于生产环境;使用它的公司包括施耐德电气(Schneider Electric)、Unity、JetBrains 和 GitHub。
在正式版发布之前,有没有办法先体验最新的功能?有一个跟踪 master 分支的 nightly build 源:虽然没有 NuGet.org 上的正式版稳定,但你能立刻拿到最新的功能和错误修复,很多用户也更喜欢用它。
在决定用它之前,我在哪里能看到真实的示例代码?该仓库链接了一系列示例应用,帮你快速上手,此外还有面向新手的文档和教程。
Creator
AvaloniaUI
Size
233.4 MB
Stars
31.7K
Age
12y
Commits · 90 Days