Dock

Dock documentation

Overview

Welcome to the Dock documentation. This page is the entry point for the documentation site and collects links to guides, reference topics and other resources. These articles explain how to use the Dock layout system from basic setup through advanced customization. The examples assume an Avalonia application created with the .NET SDK. For build instructions and an overview of the repository see the project README. If you are new to Dock, start with the guides under Get started.

Get started

• Quick start – Set up a minimal Dock layout.
• MVVM guide – Build layouts using MVVM view models.
• ReactiveUI guide – ReactiveUI equivalent of the MVVM guide.
• XAML guide – Declare layouts purely in XAML.
• Code-only guide – Build Dock layouts entirely in C#.
• User view model guide – Combine your own view models with Dock.

How-to guides

• Complex layout tutorials – Multi-window and plug-in walkthroughs.

Concepts

• Active document – Retrieve the currently focused document.
• Events guide – Subscribe to dock and window events.
• API scenarios – Common coding patterns.
• DockableLocator usage – Register and resolve dockables.
• Serialization and persistence – Save and restore layouts.
• Serialization state – Capture focus information.
• Dock state guide – Why and how to use DockState.
• Dependency injection – Register Dock services with IServiceCollection.
• Context locators – Provide DataContext objects for dockables.
• Architecture overview – High level design of the docking system.
• Deep dive – Internals of DockControl.
• DockManager guide – When and how to customize DockManager.
• Styling and theming – Customize the appearance of Dock controls.
• Custom themes – Build and apply your own theme.
• Context menus – Localize or replace built in menus.
• Control recycling – Reuse visuals when dockables return.
• Proportional StackPanel – Layout panel with adjustable proportions.
• Sizing guide – Control pixel sizes and fixed dimensions.
• Floating windows – Detach dockables into separate windows.
• Enable window drag – Drag the host window via the document tab strip.
• Host window locators – Provide platform windows for floating docks.
• Drag offset calculator – Control where the drag preview window appears.
• Floating dock adorners – Display drop indicators in a transparent window.
• Debug overlay – Visualize dock targets and drop areas.
• Pinned dock window – Show auto-hidden tools in a floating window.
• Floating window owner – Keep floating windows in front of the main window.
• RootDockDebug window – Toggle a runtime inspector for Dock layouts.
• Advanced guide – Custom factories and runtime features.
• Custom Dock.Model implementations – Integrate Dock with other MVVM frameworks.

Reference

• Reference guide – Overview of the core APIs.
• Glossary – Definitions of common Dock terms.
• Dockable property settings – Configure per item behaviour.
• Markup extensions – Load and reference XAML fragments.
• Adapter classes – Host, navigation and tracking helpers.
• Tracking controls – Collections that map dockables to their visuals.
• Enumerations – Values used by Dock APIs.
• Model control interfaces – Contracts used to define documents, tools and docks.
• Layout panels – Dock, stack, grid and wrap style docks.
• Dock settings – Global drag/drop options and thresholds.
• Dock properties – Use attached properties to mark drag areas and drop targets.
• DockSettings in controls – Apply global drag/drop settings when writing custom controls.

Samples and additional resources

See the sample applications under the samples directory for real‑world usage. The project README also lists the available guides and provides basic build instructions.

For the complete source code visit the GitHub repository. NuGet packages are published on NuGet.org, including both Dock.Avalonia and Dock.Model.Mvvm.

Troubleshooting

• FAQ – Solutions to common issues.