Documentation/SUMMARY.md

Table of contents

• 👋 Welcome

Documentation

• ⚡ Getting Started
  • IDE Support
    • JetBrains Rider Setup
  • Programming with Avalonia
    • The Model-View-ViewModel Pattern (MVVM)
    • Controls & Layouts
    • Data Binding
    • Graphics & Animations
  • Windows
  • UserControls
  • Assets
  • Developer Tools
  • Logging Errors and Warnings
  • Unhandled Exceptions
  • Application Lifetimes
• 🔄 Data Binding
  • The DataContext
  • Change Notifications
  • Bindings
  • Compiled Bindings
  • Binding to Controls
  • Converting Binding Values
  • Binding to Commands
  • Binding to Tasks and Observables
  • Binding from Code
  • Binding in a Control Template
  • Binding Classes
  • Creating and binding Attached Properties
• 🎨 Styling
  • Styles
  • Selectors
  • Resources
  • Troubleshooting
• 🧰 Controls
  • AutoCompleteBox
  • Border
  • Buttons
    • Button
    • RepeatButton
    • RadioButton
    • ToggleButton
    • ButtonSpinner
    • SplitButton
    • ToggleSplitButton
  • Calendar
  • Canvas
  • Carousel
  • CheckBox
  • ComboBox
  • ContentControl
  • ContextMenu
  • Decorator
  • DataGrid
    • DataGridColumns
  • DatePicker
  • DockPanel
  • Expander
  • Flyouts
  • Grid
  • GridSplitter
  • Image
  • ItemsControl
  • ItemsRepeater
  • LayoutTransformControl
  • ListBox
  • MaskedTextBox
  • Menu
  • NativeMenu
  • NumericUpDown
  • Panel
  • ProgressBar
  • RelativePanel
  • ScrollBar
  • ScrollViewer
  • Separator
  • Slider
  • SplitView
  • StackPanel
  • TabControl
  • TabStrip
  • TextBlock
  • TrayIcon
  • TreeDataGrid
    • Creating a Hierarchical TreeDataGrid
    • Creating a Flat TreeDataGrid
    • TreeDataGrid column types
  • TimePicker
  • TextBox
  • ToolTip
  • TreeView
  • TransitioningContentControl
  • UserControl
  • Viewbox
  • Window
  • WrapPanel
• 📚 Templates
  • Data Templates
  • Creating Data Templates in Code
  • Implementing IDataTemplate
• ✏ Authoring Controls
  • Types of Control
  • Defining Properties
• 🖱 Input
  • Routed Events
  • Clipboard
  • Hotkeys
• 🔑 Animations
  • Keyframe Animations
  • Transitions
  • PageTransitions
• 📐 Layout
  • Panels Overview
  • Alignment, Margins and Padding
  • Create a Custom Panel
• 📦 Distribution / Publishing
  • macOS

API Reference

• 🧾 Namespaces
  • Avalonia
  • Avalonia.Animation
    • Avalonia.Animation.Easings
    • Avalonia.Animation.Animators
  • Avalonia.Collections
  • Avalonia.Controls
    • Avalonia.Controls.Utils
    • Avalonia.Controls.Templates
    • Avalonia.Controls.Shapes
    • Avalonia.Controls.Remote.Server
    • Avalonia.Controls.Remote
    • Avalonia.Controls.Primitives.PopupPositioning
    • Avalonia.Controls.Primitives
    • Avalonia.Controls.Presenters
    • Avalonia.Controls.Platform.Surfaces
    • Avalonia.Controls.Platform
    • Avalonia.Controls.Notifications
    • Avalonia.Controls.Mixins
    • Avalonia.Controls.Generators
    • Avalonia.Controls.Embedding.Offscreen
    • Avalonia.Controls.Embedding
    • Avalonia.Controls.Converters
    • Avalonia.Controls.ApplicationLifetimes
  • Avalonia.Data
    • Avalonia.Data.Core.Plugins
    • Avalonia.Data.Core
    • Avalonia.Data.Converters
  • Avalonia.Diagnostics
  • Avalonia.Dialogs

Guides

• 🐣 Basics
  • Introduction to XAML
  • Code-behind
  • MVVM Architecture
  • Accessing the UI thread
• 🤿 Deep dives
  • Running your app on a Raspberry Pi
  • Running your app on a Raspberry Pi with Raspbian Lite
  • ReactiveUI
    • View Activation
    • Routing
    • Data Persistence
    • Binding to Sorted/Filtered Data
• 👩💻 Developer Guides
  • 🏭 Build Avalonia from Source
  • Comparison of Avalonia with WPF and UWP
  • Debugging Previewer
  • Debugging the XAML compiler
  • macOS Development
  • Release Process
  • Maintaining Stable Branch

Tutorials

• 📋 ToDo List App
  • Creating a new project
  • Creating a View
  • Creating a Model & ViewModel
  • Wiring up the Views
  • Locating Views
  • Adding new Items
• 📻 Music Store App
  • Setup Development Environment
  • Creating the Project
  • Creating a Modern looking Window
  • Add and Layout Controls
  • Opening a Dialog
  • Add Content to Dialog
  • Return from Dialog
  • Searching for Albums
  • Displaying Images
  • Add Items to Users Collection
  • Add Data Persistence
  • Load data at Startup
  • Summary
• Running in the Browser
• 📱 Developing for Mobile
  • Create a cross platform solution
  • Android
    • Setting up your developer environment for Android
    • Build and run your Application on a Simulator
    • Build and run your Application on a physical device
    • Configure debugging in Visual Studio Code (Linux)
  • iOS
    • Setting up your developer environment for iOS
    • Build and run your application on a Simulator
    • Build and Run your Application on your iPhone or iPad

Misc

• 👪 Community
• 🖥 WPF Developers Tips
  • Styling
  • DataTemplates
  • HierachicalDataTemplate
  • UIElement, FrameworkElement and Control
  • DependencyProperty
  • Grid
  • ItemsControl
  • Tunnelling Events
  • Class Handlers
  • PropertyChangedCallback
  • RenderTransforms and RenderTransformOrigin
• 📋 Projects that are using Avalonia
• ❔ FAQ