Skip to content

Refresh navigation control docs for current Avalonia APIs#1038

Merged
luke-whos-here merged 3 commits into
mainfrom
fix-page-type-nav-docs
Jun 24, 2026
Merged

Refresh navigation control docs for current Avalonia APIs#1038
luke-whos-here merged 3 commits into
mainfrom
fix-page-type-nav-docs

Conversation

@luke-whos-here

Copy link
Copy Markdown
Contributor

This PR updates the navigation control documentation to match the current Avalonia API surface and behavior for CommandBar, ContentPage, DrawerPage, NavigationPage, and TabbedPage.

The docs had drifted from recently merged navigation-related API changes. This update replaces stale control names, corrects property defaults and event signatures, and aligns examples with the current source, themes, tests, and ControlCatalog samples.

PR Area Documentation impact
#20794 Page-based navigation system Adds the main ContentPage, NavigationPage, DrawerPage, and TabbedPage documentation shape.
#20826 Page lifecycle timing Clarifies that page lifecycle events fire after transitions complete.
#20939 TabItem.Icon / IconTemplate Updates TabbedPage icon guidance and examples.
#20946 Page.IconTemplate and DrawerPage.DrawerIconTemplate Documents icon templates for page and drawer icon data.
#20977 ContentPage style key override Aligns ContentPage styling guidance with current behavior.
#21008 DrawerHeaderTemplate / DrawerFooterTemplate Adds missing drawer header and footer template docs.
#21041 Rename AppBar controls Replaces stale AppBarButton, AppBarToggleButton, and AppBarSeparator references with CommandBarButton, CommandBarToggleButton, and CommandBarSeparator.
#21039 CommandBar dynamic overflow Corrects dynamic overflow priority and overflow item behavior.
#21050 / #21221 Safe area fixes Clarifies safe-area behavior for DrawerPage, NavigationPage, and ContentPage.
#21226 / #21251 CommandBar overflow and icon behavior Updates CommandBar behavior details and examples to match current templates.
#21246 System back routing Keeps NavigationPage behavior documentation aligned with current back-navigation routing.
#21275 DrawerPage header template Captures the newer drawer header templating API surface.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes Avalonia navigation control documentation pages so they align with the current API surface and documented behavior for CommandBar, ContentPage, DrawerPage, NavigationPage, and TabbedPage.

Changes:

  • Adds id frontmatter and restructures/rewrites the five navigation control reference pages for updated concepts, properties, events, and examples.
  • Updates naming and guidance to match current controls (notably CommandBar* types) and newer navigation patterns (page lifecycle timing, icon templates, drawer header/footer templates).
  • Improves page structure and cross-linking (new “See also” sections and more consistent navigation between related pages).

Reviewed changes

Copilot reviewed 5 out of 17 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
controls/navigation/tabbedpage.md Reworks TabbedPage reference content, properties/events, and examples; adds new screenshots and cross-links.
controls/navigation/navigationpage.md Rewrites NavigationPage docs with updated property/method/event coverage and refreshed examples/screenshots.
controls/navigation/drawerpage.md Updates DrawerPage reference with new property tables, examples, and expanded behavior description.
controls/navigation/contentpage.md Refreshes ContentPage reference, clarifies header usage and lifecycle events, and updates examples.
controls/navigation/commandbar.md Updates CommandBar documentation to current control names and behavior, expands examples, and adds more property coverage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread controls/navigation/tabbedpage.md
Comment thread controls/navigation/tabbedpage.md Outdated
Comment thread controls/navigation/tabbedpage.md
Comment thread controls/navigation/tabbedpage.md
Comment thread controls/navigation/drawerpage.md
Comment thread controls/navigation/drawerpage.md
@luke-whos-here luke-whos-here merged commit ce08fbd into main Jun 24, 2026
1 check passed
@luke-whos-here luke-whos-here deleted the fix-page-type-nav-docs branch June 24, 2026 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants