Skip to content

Commit c54fc90

Browse files
committed
improve overlay documentation
1 parent 41b1be1 commit c54fc90

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

Screenbox/Controls/CustomNavigationView.Properties.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ public partial class CustomNavigationView
1515
nameof(Overlay), typeof(UIElement), typeof(CustomNavigationView), new PropertyMetadata(null, OnOverlayPropertyChanged));
1616

1717
/// <summary>
18-
/// Gets or sets the content to be displayed as an overlay at the same
19-
/// visual hierarchy as the <see cref="Windows.UI.Xaml.Controls.SplitView"/> pane and content.
18+
/// Gets or sets the content to be displayed as an overlay. By default, the overlay appears
19+
/// between the <see cref="Windows.UI.Xaml.Controls.SplitView"/> pane and the content area, but its order can be adjusted.
2020
/// </summary>
2121
public UIElement? Overlay
2222
{
@@ -34,7 +34,10 @@ public UIElement? Overlay
3434
/// Gets or sets the Z-order of the overlay element.
3535
/// </summary>
3636
/// <value>The ZIndex value in the range ±1,000,000. The default is 0.</value>
37-
/// <remarks>Values above 1 will render the element above the navigation pane.</remarks>
37+
/// <remarks>
38+
/// Values above 1 will render the element above the navigation pane,
39+
/// and values below -1 renders the element below the main content.
40+
/// </remarks>
3841
public int OverlayZIndex
3942
{
4043
get => (int)GetValue(OverlayZIndexProperty);

Screenbox/Controls/CustomNavigationView.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ namespace Screenbox.Controls;
2727
/// <remarks>
2828
/// <para>The <see cref="CustomNavigationView"/> provides additional features such customizable access keys,
2929
/// keyboard accelerators, and styles for the buttons that are built-in to NavigationView.</para>
30-
/// It also enables changing the visibility of navigation content and rendering a custom overlay
31-
/// with configurable z-order.
30+
/// It also supports rendering an overlay with configurable z-order and a <see cref="UIElement"/> as its content,
31+
/// while allowing the navigation pane and main content visibility to be changed independently of the overlay.
3232
/// <para>Key features include:</para>
3333
/// <list type="bullet">
34-
/// <item><description><strong>Overlay:</strong> Displayed custom content on the same layer as the navigation pane.</description></item>
34+
/// <item><description><strong>Overlay:</strong> Display custom content above the main content without obscuring the pane. The layer order can be changed.</description></item>
3535
/// <item><description><strong>Styling:</strong> Apply custom styles to built-in buttons.</description></item>
3636
/// <item><description><strong>Accessibility:</strong> Configure built-in buttons access keys and keyboard accelerators.</description></item>
3737
/// <item><description><strong>Motion:</strong> Fluid animations for content when visibility changes.</description></item>
@@ -49,7 +49,7 @@ namespace Screenbox.Controls;
4949
/// &lt;/controls:CustomNavigationView.PaneToggleButtonKeyboardAccelerators&gt;
5050
///
5151
/// &lt;controls:CustomNavigationView.Overlay&gt;
52-
/// &lt;Border Background="Red" /&gt;
52+
/// &lt;Border Background="Red" Height="200" /&gt;
5353
/// &lt;/controls:CustomNavigationView.Overlay&gt;
5454
/// &lt;/controls:CustomNavigationView&gt;
5555
/// </code>

0 commit comments

Comments
 (0)