PageSourceSearch

https://docs.avaloniaui.net/docs/welcome?av_source=marketing&av_medium=docs_link&av_content=nav

html avaloniaui.net collected 2026-09-24 17:13:57 UTC 34,571 bytes, 101 lines download raw bytes

1<!doctype html>
2<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-welcome" data-has-hydrated="false">
3<head>
4<meta charset="UTF-8">
5<meta name="generator" content="Docusaurus v3.8.1">
6<title data-rh="true">Avalonia documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.avaloniaui.net/img/social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.avaloniaui.net/img/social-card.png"><meta data-rh="true" property="og:url" content="https://docs.avaloniaui.net/docs/welcome"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Welcome | Avalonia Docs"><meta data-rh="true" property="og:description" content="Get started with the Avalonia cross-platform .NET UI framework. Find installation guides, tutorials, migration paths, and API references."><meta data-rh="true" name="description" content="Documentation for Avalonia, the cross-platform .NET UI framework. Build apps for Windows, macOS, Linux, iOS, Android, and WebAssembly from a single codebase."><link data-rh="true" rel="canonical" href="https://docs.avaloniaui.net/docs/welcome"><link data-rh="true" rel="alternate" href="https://docs.avaloniaui.net/docs/welcome" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.avaloniaui.net/docs/welcome" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://V9UF6750GH-dsn.algolia.net" crossorigin="anonymous">
6<script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Guides","item":"https://docs.avaloniaui.net/docs/welcome"}]}</script>
6<link rel="search" type="application/opensearchdescription+xml" title="Avalonia Docs" href="/opensearch.xml">
7
8
9<script>function getCookie(e){const t=`; ${document.cookie}`.split(`; ${e}=`);return 2===t.length?t.pop().split(";").shift():null}!function(){var e=window.analytics=window.analytics||[];if(!e.initialize)if(e.invoked)window.console&&console.error&&console.error("Snippet included twice.");else{e.invoked=!0,e.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"],e.factory=function(t){return function(){var n=Array.prototype.slice.call(arguments);return n.unshift(t),e.push(n),e}};for(var t=0;t<e.methods.length;t++){var n=e.methods[t];e[n]=e.factory(n)}e.load=function(t,n){var o=document.createElement("script");o.type="text/javascript",o.async=!0,o.src="https://cdp-eu.customer.io/v1/analytics-js/snippet/"+t+"/analytics.min.js";var i=document.getElementsByTagName("script")[0];i.parentNode.insertBefore(o,i),e._writeKey=t,e._loadOptions=n},e.SNIPPET_VERSION="4.15.3",e.load("4fe6898c1dcf35b4fb67"),e.page()}}(),document.addEventListener("DOMContentLoaded",(function(){const e=getCookie("user_id");e&&analytics.identify(e,{})}))</script>
9
10
11
12<link rel="preconnect" href="https://www.clarity.ms">
13<script>!function(t,e,n,c,a,r,s){t[n]=t[n]||function(){(t[n].q=t[n].q||[]).push(arguments)},(r=e.createElement(c)).async=1,r.src="https://www.clarity.ms/tag/hqhy3ac3l1",(s=e.getElementsByTagName(c)[0]).parentNode.insertBefore(r,s)}(window,document,"clarity","script")</script>
vendor: 1 bytes, line 13
13
14<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("consent","default",{ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",analytics_storage:"denied",functionality_storage:"granted",personalization_storage:"denied",security_storage:"granted",wait_for_update:500}),function(){var a=document.cookie.match(/(?:^|; )av_cookie_consent=([^;]*)/);if(a)try{var e=JSON.parse(decodeURIComponent(a[1]));gtag("consent","update",{analytics_storage:e.analytics?"granted":"denied",ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",personalization_storage:e.messaging?"granted":"denied"})}catch(a){}}()</script>
14
15<link rel="preconnect" href="https://www.googletagmanager.com">
16<script>window.dataLayer=window.dataLayer||[]</script>
vendor: 1 bytes, line 16
16
17<script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-P3B9LZDZ",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script>
17
18
19
20
21
22<script defer="defer" data-domain="docs.avaloniaui.net" src="https://plausible.io/js/script.js"></script>
22
23
24
25
26<link rel="apple-touch-icon" sizes="180x180" href="/favicons/apple-touch-icon.png">
27<link rel="icon" type="image/png" sizes="32x32" href="/favicons/favicon-32x32.png">
28<link rel="icon" type="image/png" sizes="16x16" href="/favicons/favicon-16x16.png">
29<link rel="shortcut icon" type="image/x-icon" href="/favicons/favicon.ico">
30<link rel="manifest" href="/favicons/site.webmanifest">
31<link rel="mask-icon" color="#ffffff" href="/favicons/safari-pinned-tab.svg">
32<meta name="theme-color" content="#ffffff">
33<meta name="msapplication-config" content="/favicons/browserconfig.xml">
34<script src="https://white-hill-09a5c3303.3.azurestaticapps.net/AvaloniaPreviewElement.js" type="module" async></script>
34<link rel="stylesheet" href="/assets/css/styles.305961d3.css">
35<script src="/assets/js/runtime~main.5fb6b5b7.js" defer="defer"></script>
vendor: 1 bytes, line 35
35
36<script src="/assets/js/main.2561136b.js" defer="defer"></script>
36
37</head>
38<body class="navigation-with-keyboard">
39<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"><defs>
40<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
41</defs></svg>
42<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script>
vendor: 76 bytes, lines 42-51
42
43
44
45
46
47
48
49
50
51<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=
51GTM-P3B9LZDZ
vendor: 82 bytes, line 51
51" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
51<div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_CIJY"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><a target="_self" href="/"><img src="/logo/docs-logo-light.svg" alt="Avalonia Logo" class="themedComponent_mlkZ themedComponent--light_NVdE" height="28" width="139"><img src="/logo/docs-logo-dark.svg" alt="Avalonia Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU" height="28" width="139"></a><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/welcome">Welcome</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/supported-platforms">Supported platforms</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/get-started/">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/fundamentals/avalonia-xaml">Fundamentals</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/xaml/">XAML Reference</a><button aria-label="Expand sidebar category &#x27;XAML Reference&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/layout/">Layout</a><button aria-label="Expand sidebar category &#x27;Layout&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/styling/styles">Styling</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/data-binding/introduction-to-data-binding">Data Binding</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/data-templates/introduction-to-data-templates">Data Templates</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/properties/">Property System</a><button aria-label="Expand sidebar category &#x27;Property System&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/events/">Events</a><button aria-label="Expand sidebar category &#x27;Events&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/input-interaction/pointer">Input &amp; Interaction</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/graphics-animation/brushes">Graphics and Animation</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/custom-control
51s/">Custom controls</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/services/clipboard">Services</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/app-development/cross-platform-solution-setup">App Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/platform-specific-guides/windows">Platform Integration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/testing/">Testing</a><button aria-label="Expand sidebar category &#x27;Testing&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/deployment/macos">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/migration/wpf/">Migration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/how-to/treeview-how-to">How-To Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/samples-tutorials/">Samples &amp; Tutorials</a><button aria-label="Expand sidebar category &#x27;Samples &amp; Tutorials&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/avalonia12-breaking-changes">Breaking changes</a></li></ul></nav></div></div></aside><div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" target="_self" href="/"><div class="navbar__logo"><img src="/logo/docs-logo-light.svg" alt="Avalonia Logo" class="themedComponent_mlkZ themedComponent--light_NVdE" height="28" width="139"><img src="/logo/docs-logo-dark.svg" alt="Avalonia Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU" height="28" width="139"></div></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/welcome">Guides</a><a class="navbar__item navbar__link" href="/controls">Controls</a><a class="navbar__item navbar__link" href="/tools">Tools</a><a class="navbar__item navbar__link" href="/api">APIs</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link navbar__link--community">More</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/troubleshooting">Troubleshooting</a></li><li><a class="dropdown__link" href="/docs/community-translations">Community Translations</a></li><li><a href="https://avaloniaui.net/support?av_source=docs&amp;av_medium=nav_link&amp;av_content=support" target="_blank" class="dropdown__link">Enhanced Support<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://avaloniaui.net/services" target="_blank" class="dropdown__link">Professional Services<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://github.com/AvaloniaUI/Avalonia/discussions" target="_blank" class="dropdown__link">GitHub Discussions<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://avaloniaui.net/blog" target="_blank" class="dropdown__link">Blog<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="navbar__item"><div class="separator" aria-hidden></div></div><a class="navbar__item navbar__link" href="/xpf">Avalonia XPF</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="navbarSearchContainer_Bca1"><div class="DocSearch-SearchBar"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts="Meta+k"><span class="DocSearch-Button-Container">
51<svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 24 24" aria-hidden="true"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button><button class="DocSearch-SidepanelButton inline" type="button" aria-label="Ask AI (Meta+i)" aria-keyshortcuts="Meta+i"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.3" stroke-linecap="round" stroke-linejoin="round" class="DocSearch-Hit-icon-sparkles"><path d="M9.937 15.5A2 2 0 0 0 8.5 14.063l-6.135-1.582a.5.5 0 0 1 0-.962L8.5 9.936A2 2 0 0 0 9.937 8.5l1.582-6.135a.5.5 0 0 1 .963 0L14.063 8.5A2 2 0 0 0 15.5 9.937l6.135 1.581a.5.5 0 0 1 0 .964L15.5 14.063a2 2 0 0 0-1.437 1.437l-1.582 6.135a.5.5 0 0 1-.963 0z"></path><path d="M20 3v4"></path><path d="M22 5h-4"></path><path d="M4 17v2"></path><path d="M5 18H3"></path></svg></button></div></div><div class="colorModeToggle_x44X"><button type="button" disabled="" title="Switch to dark mode" aria-label="Switch to dark mode" style="display:flex;align-items:center;justify-content:center;width:2rem;height:2rem;border-radius:50%;border:none;background:none;cursor:pointer;padding:0;color:var(--color-gray-400)"><svg viewBox="0 0 24 24" width="20" height="20"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><a href="https://github.com/avaloniaui/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Alpn" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link breadcrumbLink_Pj1F" aria-current="page"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_SLhD" aria-hidden="true"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg>Guides</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Welcome</h1></header>
52<p>Welcome to the Avalonia documentation. Whether you are building your first app or migrating an existing project, these docs cover everything from installation to deployment.</p>
53<div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 24 24" fill="currentColor"><path fill-rule="evenodd" clip-rule="evenodd" d="M3.6501 11.9996C3.6501 7.38803 7.38852 3.64961 12.0001 3.64961C16.6117 3.64961 20.3501 7.38803 20.3501 11.9996C20.3501 16.6112 16.6117 20.3496 12.0001 20.3496C7.38852 20.3496 3.6501 16.6112 3.6501 11.9996ZM12.0001 1.84961C6.39441 1.84961 1.8501 6.39392 1.8501 11.9996C1.8501 17.6053 6.39441 22.1496 12.0001 22.1496C17.6058 22.1496 22.1501 17.6053 22.1501 11.9996C22.1501 6.39392 17.6058 1.84961 12.0001 1.84961ZM10.9992 7.52468C10.9992 8.07697 11.4469 8.52468 11.9992 8.52468H12.0002C12.5525 8.52468 13.0002 8.07697 13.0002 7.52468C13.0002 6.9724 12.5525 6.52468 12.0002 6.52468H11.9992C11.4469 6.52468 10.9992 6.9724 10.9992 7.52468ZM12.0002 17.371C11.586 17.371 11.2502 17.0352 11.2502 16.621V10.9445C11.2502 10.5303 11.586 10.1945 12.0002 10.1945C12.4144 10.1945 12.7502 10.5303 12.7502 10.9445V16.621C12.7502 17.0352 12.4144 17.371 12.0002 17.371Z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>These docs cover Avalonia 12. For Avalonia 11 documentation, visit <a href="https://v11.docs.avaloniaui.net/" target="_blank" rel="noopener noreferrer">v11.docs.avaloniaui.net</a>.</p></div></div>
54<h2 class="anchor anchorWithStickyNavbar_LWe7" id="what-is-avalonia">
54What is Avalonia?<a href="#what-is-avalonia" class="hash-link" aria-label="Direct link to What is Avalonia?" title="Direct link to What is Avalonia?">​</a></h2>
55<p>Avalonia is an open-source, cross-platform UI framework for building applications with .NET. It uses its own rendering engine to draw controls, so your app looks and behaves the same on every platform. Write your UI once in C# or F# with XAML, and deploy to:</p>
56<ul>
57<li><strong>Windows</strong> (10, 11)</li>
58<li><strong>macOS</strong> (Apple Silicon and Intel)</li>
59<li><strong>Desktop Linux</strong> (X11 and Wayland)</li>
60<li><strong>Embedded Linux</strong> (framebuffer on Raspberry Pi and similar devices)</li>
61<li><strong>iOS</strong> and <strong>Android</strong></li>
62<li><strong>WebAssembly</strong></li>
63</ul>
64<p>For exact version and architecture details, see <a href="/docs/supported-platforms">Supported platforms</a>.</p>
65<h2 class="anchor anchorWithStickyNavbar_LWe7" id="key-capabilities">Key capabilities<a href="#key-capabilities" class="hash-link" aria-label="Direct link to Key capabilities" title="Direct link to Key capabilities">​</a></h2>
66<div class="table-wrapper"><table><thead><tr><th>Capability</th><th>Description</th></tr></thead><tbody><tr><td><strong>Cross-platform rendering</strong></td><td>Avalonia&#x27;s own rendering engine produces pixel-identical output on every platform. Skia is the default backend, and the team is collaborating with Google&#x27;s Flutter team to bring the <a href="https://avaloniaui.net/blog/avalonia-partners-with-google-s-flutter-t-eam-to-bring-impeller-rendering-to-net" target="_blank" rel="noopener noreferrer">Impeller</a> rendering engine to .NET. No native control wrappers, no platform-specific quirks.</td></tr><tr><td><strong>XAML and code-behind</strong></td><td>Describe your UI declaratively with XAML or build it entirely in code. Avalonia XAML will feel familiar if you have worked with WPF or UWP.</td></tr><tr><td><strong>Styling system</strong></td><td>A CSS-inspired styling system with selectors, style classes, pseudoclasses, and control themes. See <a href="/docs/styling/styles">Styles</a>.</td></tr><tr><td><strong>Data binding</strong></td><td>Compiled bindings checked at build time, full MVVM support, and integration with CommunityToolkit.Mvvm. See <a href="/docs/data-binding/introduction-to-data-binding">Data binding</a>.</td></tr><tr><td><strong>Rich control library</strong></td><td>60+ built-in controls including DataGrid, TreeView, TabControl, Calendar, and more. Fully styleable and templatable.</td></tr><tr><td><strong>Accessibility</strong></td><td>Built-in support for screen readers and keyboard navigation across platforms.</td></tr><tr><td><strong>DevTools</strong></td><td>Press <kbd>F12</kbd> at runtime to inspect the visual tree, properties, styles, and layout.</td></tr></tbody></table></div>
67<h2 class="anchor anchorWithStickyNavbar_LWe7" id="choose-your-path">Choose your path<a href="#choose-your-path" class="hash-link" aria-label="Direct link to Choose your path" title="Direct link to Choose your path">​</a></h2>
68<h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-to-avalonia">New to Avalonia?<a href="#new-to-avalonia" class="hash-link" aria-label="Direct link to New to Avalonia?" title="Direct link to New to Avalonia?">​</a></h3>
69<ol>
70<li><a href="/docs/get-started/install-avalonia">Install Avalonia</a> and <a href="/docs/get-started/set-up-your-ide">set up your IDE</a></li>
71<li><a href="/docs/get-started/create-your-first-project">Create your first project</a></li>
72<li><a href="/docs/get-started/starter-tutorial">Follow the starter tutorial</a> to build a temperature converter app</li>
73<li><a href="/docs/fundamentals/avalonia-xaml">Learn the fundamentals</a>: XAML, controls, layout, and the visual tree</li>
74</ol>
75<h3 class="anchor anchorWithStickyNavbar_LWe7" id="coming-from-wpf">Coming from WPF?<a href="#coming-from-wpf" class="hash-link" aria-label="Direct link to Coming from WPF?" title="Direct link to Coming from WPF?">​</a></h3>
76<p>Avalonia&#x27;s API is intentionally close to WPF, but there are important differences in styling, templates, and the property system.</p>
77<ul>
78<li><a href="/docs/migration/wpf">
78WPF migration guide</a>: a section-by-section comparison</li>
79<li><a href="/docs/migration/wpf/cheat-sheet">WPF cheat sheet</a>: quick mapping of WPF concepts to Avalonia equivalents</li>
80</ul>
81<p>If you need to run an existing WPF application cross-platform without rewriting it, <a href="/xpf">Avalonia XPF</a> provides binary-compatible WPF support on top of Avalonia&#x27;s rendering engine.</p>
82<h3 class="anchor anchorWithStickyNavbar_LWe7" id="upgrading-from-avalonia-11">Upgrading from Avalonia 11?<a href="#upgrading-from-avalonia-11" class="hash-link" aria-label="Direct link to Upgrading from Avalonia 11?" title="Direct link to Upgrading from Avalonia 11?">​</a></h3>
83<p>Avalonia 12 includes compiled bindings by default, a new clipboard API, updated window decorations, and more.</p>
84<ul>
85<li><a href="/docs/avalonia12-breaking-changes">Breaking changes in Avalonia 12</a>: full list with migration guidance for each change</li>
86</ul>
87<h3 class="anchor anchorWithStickyNavbar_LWe7" id="looking-for-samples">Looking for samples?<a href="#looking-for-samples" class="hash-link" aria-label="Direct link to Looking for samples?" title="Direct link to Looking for samples?">​</a></h3>
88<ul>
89<li><a href="/docs/samples-tutorials">Samples and tutorials</a>: starter apps, real-world examples, and video walkthroughs</li>
90</ul>
91<h2 class="anchor anchorWithStickyNavbar_LWe7" id="need-help">Need help?<a href="#need-help" class="hash-link" aria-label="Direct link to Need help?" title="Direct link to Need help?">​</a></h2>
92<p>If you get stuck, check the <a href="/troubleshooting">Troubleshooting</a> pages or connect with the community on <a href="https://github.com/AvaloniaUI/Avalonia/discussions" target="_blank" rel="noopener noreferrer">GitHub Discussions</a>.</p>
93<p>To report a bug, open an issue on <a href="https://github.com/AvaloniaUI/Avalonia" target="_blank" rel="noopener noreferrer">GitHub</a>.</p>
94<h2 class="anchor anchorWithStickyNavbar_LWe7" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also">​</a></h2>
95<ul>
96<li><a href="/docs/supported-platforms">Supported platforms</a></li>
97<li><a href="/docs/samples-tutorials">Samples and tutorials</a></li>
98<li><a href="https://github.com/AvaloniaUI/Avalonia" target="_blank" rel="noopener noreferrer">Avalonia GitHub repository</a></li>
99</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/AvaloniaUI/avalonia-docs/tree/main/docs/welcome.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="none" width="14" height="14" viewBox="0 0 14 14" class="iconEdit_dqTn" aria-hidden="true" xmlns="http://www.w3.org/2000/svg"><g><path d="M7 0C3.13438 0 0 3.21563 0 7.17813C0 10.35 2.00625 13.0375 4.7875 13.9875C4.83125 13.9969 4.86875 14 4.90625 14C5.16563 14 5.26562 13.8094 5.26562 13.6438C5.26562 13.4719 5.25938 13.0219 5.25625 12.4219C4.99375 12.4812 4.75938 12.5063 4.55 12.5063C3.20313 12.5063 2.89687 11.4594 2.89687 11.4594C2.57812 10.6313 2.11875 10.4094 2.11875 10.4094C1.50938 9.98125 2.11562 9.96875 2.1625 9.96875H2.16563C2.86875 10.0312 3.2375 10.7125 3.2375 10.7125C3.5875 11.325 4.05625 11.4969 4.475 11.4969C4.80312 11.4969 5.1 11.3906 5.275 11.3094C5.3375 10.8469 5.51875 10.5312 5.71875 10.35C4.16563 10.1688 2.53125 9.55313 2.53125 6.80312C2.53125 6.01875 2.80312 5.37813 3.25 4.87813C3.17812 4.69688 2.9375 3.96563 3.31875 2.97813C3.31875 2.97813 3.36875 2.9625 3.475 2.9625C3.72812 2.9625 4.3 3.05937 5.24375 3.71562C5.80312 3.55625 6.4 3.47812 6.99687 3.475C7.59062 3.47812 8.19063 3.55625 8.75 3.71562C9.69375 3.05937 10.2656 2.9625 10.5188 2.9625C10.625 2.9625 10.675 2.97813 10.675 2.97813C11.0563 3.96563 10.8156 4.69688 10.7437 4.87813C11.1906 5.38125 11.4625 6.02187 11.4625 6.80312C11.4625 9.55937 9.825 10.1656 8.26562 10.3438C8.51562 10.5656 8.74063 11.0031 8.74063 11.6719C8.74063 12.6313 8.73125 13.4062 8.73125 13.6406C8.73125 13.8094 8.82812 14 9.0875 14C9.125 14 9.16875 13.9969 9.2125 13.9875C11.9969 13.0375 14 10.3469 14 7.17813C14 3.21563 10.8656 0 7 0Z" fill="currentColor"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2026-04-20T17:40:52.000Z" itemprop="dateModified">Apr 20, 2026</time></b> by <b>Luke</b></span></div></div><div></div></footer><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/supported-platforms"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Supported platforms</div></a></nav></article></div></div><div class="col col--3"><div class="tableOfContentsWrapper_cC_z"><h3 class="tocHeading_phon uppercase">On this page</h3><div class="tocDropdownRow_PKuY"><button class="dropdown-toggle tocDropdownButton_BGOJ">Open in<svg class="duration-200 ease-in-out stroke-current" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M4.79199 7.396L10.0003 12.6043L15.2087 7.396" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div><div class="tableOfContents_jeP5 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#what-is-avalonia" class="table-of-contents__link toc-highlight">What is Avalonia?</a></li><li><a href="#key-capabilities" class="table-of-contents__link toc-highlight">Key capabilities</a></li><li><a href="#choose-your-path" class="table-of-contents__link toc-highlight">Choose your path</a><ul><li><a href="#new-to-avalonia" class="table-of-contents__link toc-highlight">New to Avalonia?</a></li><li><a href="#coming-from-wpf" class="table-of-contents__link toc-highlight">Coming from WPF?</a></li><li><a href="#upgrading-from-avalonia-11" class="table-of-contents__link toc-highlight">Upgrading from Avalonia 11?</a></li><li><a href="#looking-for-samples" class="table-of-contents__link toc-highlight">Looking for samples?</a></li></ul></li><li><a href="#need-help" class="table-of-contents__link toc-highlight">Need help?</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></div></main></div></div></div></div></div>
100</body>
101</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.