Avalonia UI Documentation
website·Indexed 35 days ago
https://v11.docs.avaloniaui.netDocumentation for Avalonia UI v11, a cross-platform UI framework. Includes guides on building layouts, styling with Fluent and Simple themes, and detailed references for controls such as TreeDataGrid, DataGrid, ScrollViewer, and various button types. Also covers Avalonia Accelerate tools, including Developer Tools, Parcel signing for macOS, and storage provider services.
What's inside Avalonia UI
- The Model Context Protocol (MCP) server provided by Avalonia Developer Tools allows AI assistants to inspect and interact with an Avalonia application's visual tree, search for elements, and access diagnostic information through a unified interface.
Overview of Avalonia Application Breakpoints Tool
The Application Breakpoints Tool allows developers to monitor and debug property changes and events in Avalonia applications without modifying code. A breakpoint is triggered (marked as 'Hit') when the following conditions are met:
- The property is changed (for property breakpoints) or the event is raised (for event breakpoints).
- The breakpoint is enabled.
- If a target is assigned, it matches the source of the property/event.
- The hit count criteria is satisfied.
Overview of Avalonia UI framework
Avalonia is an open-source, cross-platform UI framework for .NET developers. Unlike frameworks that rely on native OS controls, Avalonia uses its own rendering engine to draw the entire UI, ensuring a consistent experience and high customization across platforms. It supports C# (and other .NET languages) and uses XAML for UI definition, featuring a styling system and binding infrastructure similar to WPF.Overview of the SplitButton control
TheSplitButtonis used to group similar actions where one action has clear priority. It consists of two parts: a primary part that behaves like a standardButtonfor the most common action, and a secondary part (drop-down) that opens aFlyoutcontaining less-common actions. All actions, whether triggered via the primary button or the flyout, are executed immediately upon selection.Overview of Avalonia animation support
Avalonia UI features a CSS-like animation system that allows controls to grow, shake, spin, and fade. The system primarily supports two types of animations: property transitions and keyframe animations.Overview of the RepeatButton control
TheRepeatButtonis a specialized button control in Avalonia that regularly generates click events as long as the button remains pressed down, rather than firing a single event per click.Overview of Avalonia Accelerate features
Avalonia Accelerate is a professional suite of enhancements for Avalonia development. It includes the following tools and components:
- Dev Tools: Professional-grade tooling for inspecting visual trees and debugging bindings.
- Parcel: A packaging tool (GUI and console) for building, signing, and packaging applications for Windows, macOS, and Linux.
- Visual Studio Extension: An enhanced extension providing a faster, smarter editing experience and a Previewer for real-time UI feedback.
- Web View: A component for embedding secure, high-performance web browsing experiences within applications.
- Media Player: A module for native video and audio playback across Windows, macOS, and Linux.
- Markdown Control: A control for rendering rich Markdown content with custom styling and selection support.
- Tree Data Grid: An advanced data grid component for complex data representation.
Overview of Avalonia UI Menu Controls
Avalonia UI provides several controls for implementing navigation and action menus within an application:
Menu: Used as a top-level menu, typically located at the top of a window.ContextMenu: A popup menu that is attached to another control and typically appears on right-click.NativeMenu: Specifically used to display native system menus on macOS and certain Linux distributions.TabStrip: A control that functions as a horizontal menu for switching between views or sections.
Overview of AvaloniaUI Headless platform
The headless platform in AvaloniaUI allows applications to run without a visible graphical user interface (GUI). This is primarily used for UI testing, automation, and validating functionality in environments lacking a graphical shell, such as servers or CI/CD pipelines.Overview of Avalonia styling mechanisms
Avalonia provides three distinct ways to style controls depending on the goal:
- Styles: Similar to CSS, these are used to style controls based on their content or purpose (e.g., creating a specific look for all header text blocks).
- Control Themes: Similar to WPF/UWP styles, these are used to define the overall visual theme of a control.
- Container Queries: A collection of styles that are applied dynamically based on the size of the control's container.
Overview of NativeWebView
NativeWebView is a control for Avalonia and WPF applications that wraps platform-specific web controls to provide a unified API for web browsing functionality. It is supported on Windows (WebView2-Edge), macOS/iOS (WKWebView), and Android, but is not supported on Linux or within a Browser environment.Overview of Avalonia Calendar control
The Calendar control allows users to select specific dates or date ranges. It supports various selection modes and can be configured to restrict certain dates or define the visible date range.