API Reference
The DocFX site generates API pages from all 18 packable projects under src/. Browse by package and namespace, or use site search to find public types and members. Each project's compiled public API and C# XML documentation comments are the source for the generated reference.
Open the published API reference
NuGet packages
| Package | API area |
|---|---|
Md3.Avalonia |
Core controls, themes, motion, and platform services. |
Md3.Avalonia.Extra |
Optional controls, layout, and data-provider contracts. |
Md3.Avalonia.Icons |
Full Material Symbols Rounded catalog. |
Md3.Avalonia.Icons.Lite |
Reduced Material Symbols font and catalog. |
Md3.Avalonia.DataGrid |
Material theme for Avalonia DataGrid. |
Md3.Avalonia.RichEditor |
Material theme for AvaloniaRichEditor. |
Md3.Avalonia.AvaloniaEdit |
Material theme for AvaloniaEdit. |
Md3.Avalonia.AvaloniaHex |
Material theme for AvaloniaHex. |
Md3.Avalonia.Dock |
Material theme for Dock. |
Md3.Avalonia.Tabalonia |
Material theme for Tabalonia. |
Md3.Avalonia.Markdown |
Material styles for Markdown.Avalonia. |
Md3.Avalonia.LiveCharts2 |
Material theme for LiveCharts2. |
Md3.Avalonia.ScottPlot |
Material theme for ScottPlot. |
Md3.Avalonia.PropertyGrid |
Material theme for Avalonia.PropertyGrid. |
Md3.Avalonia.NodifyM |
Material theme for NodifyM. |
Md3.Avalonia.Mapsui |
Material theme for Mapsui. |
Md3.Avalonia.InkCanvas |
Handwriting canvas theme and signature pad. |
Md3.Avalonia.Notifications |
Cross-platform system notifications. |
Source of truth
Public API summaries, contracts, parameter descriptions, and symbol-level examples are maintained in C# XML comments beside their declarations. DocFX builds the generated reference from the 18 projects' public APIs and XML documentation files. Task-oriented walkthroughs and screen-sized examples live in the guides below; the generated MdSymbols and MdSymbolsLite glyph catalogs are intentionally excluded so thousands of constants do not overwhelm API navigation and search.
Guides
- Quick start — install the core package, register
MaterialTheme, and add a first screen. - Usage examples — form binding, icons, dynamic color, waterfall layout, and dialogs, with screenshots.
- NuGet packages — all 18 package IDs, target frameworks, and theme entry points.
- Project structure — repository map and API-documentation build flow.
- Compatibility and the dialog service guide.
Run python3 scripts/check-api-doc-coverage.py from the repository root to verify the DocFX project set, XML output, XML comment validity, and bilingual public-interface summaries.