Skip to content

[Windows][net11] Make Layout AutomationPeer public + opt-in for screen reader tree #35909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kubaflo wants to merge 1 commit into from
Closed

[Windows][net11] Make Layout AutomationPeer public + opt-in for screen reader tree #35909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/Controls/src/Core/Element/Element.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Automation.Peers;
using NativeAutomationProperties = Microsoft.UI.Xaml.Automation.AutomationProperties;

namespace Microsoft.Maui.Controls
{
Expand All @@ -12,8 +15,22 @@ public static void MapAutomationPropertiesIsInAccessibleTree(IElementHandler han
if (handler.IsConnectingHandler() && element.GetValue(AutomationProperties.IsInAccessibleTreeProperty) is null)
return;

Platform.AccessibilityExtensions.SetAutomationPropertiesAccessibilityView(
handler.PlatformView as Microsoft.UI.Xaml.FrameworkElement, element);
if (handler.PlatformView is not FrameworkElement platformView)
return;

var isInAccessibleTree = (bool?)element.GetValue(AutomationProperties.IsInAccessibleTreeProperty);
if (isInAccessibleTree == true)
{
platformView.SetValue(NativeAutomationProperties.AccessibilityViewProperty, AccessibilityView.Content);
}
else if (isInAccessibleTree == false)
{
platformView.SetValue(NativeAutomationProperties.AccessibilityViewProperty, AccessibilityView.Raw);
}
else
{
platformView.ClearValue(NativeAutomationProperties.AccessibilityViewProperty);
}
}

public static void MapAutomationPropertiesLabeledBy(IElementHandler handler, Element element)
Expand Down
263 changes: 263 additions & 0 deletions src/Controls/tests/DeviceTests/Elements/Layout/LayoutTests.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
using Microsoft.Maui.Controls;
using Microsoft.Maui.Graphics;
using Microsoft.Maui.Handlers;
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Platform;
using Microsoft.UI.Xaml.Automation.Peers;
using Xunit;

namespace Microsoft.Maui.DeviceTests
Expand All @@ -26,5 +28,266 @@ void ValidateInputTransparentOnPlatformView(IView view)
Assert.Equal(view.InputTransparent, !handler.PlatformView.IsHitTestVisible);
}
}
void SetupLayoutBuilder()
{
EnsureHandlerCreated(builder =>
{
builder.ConfigureMauiHandlers(handlers =>
{
handlers.AddHandler<Grid, LayoutHandler>();
handlers.AddHandler<VerticalStackLayout, LayoutHandler>();
handlers.AddHandler<HorizontalStackLayout, LayoutHandler>();
handlers.AddHandler<AbsoluteLayout, LayoutHandler>();
handlers.AddHandler<FlexLayout, LayoutHandler>();
handlers.AddHandler<StackLayout, LayoutHandler>();
});
});
}

[Fact(DisplayName = "LayoutPanel creates a MauiLayoutAutomationPeer")]
public async Task LayoutPanelCreatesMauiLayoutAutomationPeer()
{
SetupLayoutBuilder();

var grid = new Grid();

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.IsType<MauiLayoutAutomationPeer>(peer);
});
}

[Fact(DisplayName = "LayoutPanel AutomationPeer default control type is Custom")]
public async Task LayoutPanelAutomationPeerDefaultControlTypeIsCustom()
{
SetupLayoutBuilder();

var grid = new Grid();

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.Equal(AutomationControlType.Custom, peer.GetAutomationControlType());
Assert.Equal(string.Empty, peer.GetLocalizedControlType());
});
}

[Theory(DisplayName = "LayoutPanel class name reflects cross-platform layout type")]
[InlineData(typeof(Grid), "Grid")]
[InlineData(typeof(VerticalStackLayout), "VerticalStackLayout")]
[InlineData(typeof(HorizontalStackLayout), "HorizontalStackLayout")]
[InlineData(typeof(AbsoluteLayout), "AbsoluteLayout")]
[InlineData(typeof(FlexLayout), "FlexLayout")]
[InlineData(typeof(StackLayout), "StackLayout")]
public async Task LayoutPanelClassNameReflectsCrossPlatformType(Type layoutType, string expectedClassName)
{
SetupLayoutBuilder();

var layout = (Layout)Activator.CreateInstance(layoutType)!;

// FlexLayout._root is only initialized when it has a MAUI parent.
// Wrap it in a VerticalStackLayout so OnParentSet() fires before layout runs.
Layout root = layout is FlexLayout
? new VerticalStackLayout { layout }
: layout;

await AttachAndRun(root, (LayoutHandler handler) =>
{
// For FlexLayout, find the inner FlexLayout's platform view via its handler
var targetView = layout is FlexLayout
? (layout.Handler as LayoutHandler)?.PlatformView ?? handler.PlatformView
: handler.PlatformView;

var peer = FrameworkElementAutomationPeer.CreatePeerForElement(targetView);
Assert.Equal(expectedClassName, peer.GetClassName());
});
}

[Theory(DisplayName = "LayoutPanel AutomationId is exposed via the automation peer")]
[InlineData(true)]
[InlineData(false)]
public async Task LayoutPanelAutomationIdIsExposedViaPeer(bool hasAutomationId)
{
SetupLayoutBuilder();

var grid = new Grid();
if (hasAutomationId)
grid.AutomationId = "TestGrid";

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
var expected = hasAutomationId ? "TestGrid" : string.Empty;
Assert.Equal(expected, peer.GetAutomationId());
});
}

[Fact(DisplayName = "LayoutPanel AutomationPeer is not keyboard focusable")]
public async Task LayoutPanelAutomationPeerIsNotKeyboardFocusable()
{
SetupLayoutBuilder();

var grid = new Grid();

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.False(peer.IsKeyboardFocusable());
});
}

[Fact(DisplayName = "LayoutPanel without automation signals is excluded from Control and Content views")]
public async Task LayoutPanelWithoutAutomationSignalsIsExcludedFromControlAndContentViews()
{
SetupLayoutBuilder();

var grid = new Grid();

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.False(peer.IsControlElement());
Assert.False(peer.IsContentElement());
});
}

[Fact(DisplayName = "LayoutPanel with AutomationId is included in Control view only")]
public async Task LayoutPanelWithAutomationIdIsIncludedInControlViewOnly()
{
SetupLayoutBuilder();

var grid = new Grid { AutomationId = "TestGrid" };

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);

Assert.Equal("TestGrid", peer.GetAutomationId());
Assert.True(peer.IsControlElement());
Assert.False(peer.IsContentElement());
Assert.Equal(AutomationControlType.Custom, peer.GetAutomationControlType());
Assert.Equal(string.Empty, peer.GetLocalizedControlType());
});
}

[Fact(DisplayName = "LayoutPanel opts into Control view when AutomationProperties.IsInAccessibleTree is true")]
public async Task LayoutPanelOptsIntoControlViewViaIsInAccessibleTree()
{
SetupLayoutBuilder();

var grid = new Grid();
AutomationProperties.SetIsInAccessibleTree(grid, true);

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.True(peer.IsControlElement());
Assert.True(peer.IsContentElement());
Assert.Equal(AutomationControlType.Pane, peer.GetAutomationControlType());
});
}

[Fact(DisplayName = "LayoutPanel opts into Control view when SemanticProperties.Description is set")]
public async Task LayoutPanelOptsIntoControlViewWhenDescriptionIsSet()
{
SetupLayoutBuilder();

var grid = new Grid();
SemanticProperties.SetDescription(grid, "Welcome card");

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.True(peer.IsControlElement());
Assert.Equal(AutomationControlType.Pane, peer.GetAutomationControlType());
});
}

[Fact(DisplayName = "LayoutPanel opts into Control view when SemanticProperties.Hint is set")]
public async Task LayoutPanelOptsIntoControlViewWhenHintIsSet()
{
SetupLayoutBuilder();

var grid = new Grid();
SemanticProperties.SetHint(grid, "Contains welcome card actions");

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.True(peer.IsControlElement());
Assert.Equal(AutomationControlType.Pane, peer.GetAutomationControlType());
});
}

[Fact(DisplayName = "LayoutPanel explicit accessible-tree opt out overrides AutomationId and SemanticProperties.Description")]
public async Task LayoutPanelAccessibleTreeOptOutOverridesAutomationIdAndDescription()
{
SetupLayoutBuilder();

var grid = new Grid { AutomationId = "TestGrid" };
SemanticProperties.SetDescription(grid, "Welcome card");
AutomationProperties.SetIsInAccessibleTree(grid, false);

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.Equal("TestGrid", peer.GetAutomationId());
Assert.False(peer.IsControlElement());
Assert.False(peer.IsContentElement());
});
}

[Fact(DisplayName = "LayoutPanel ignores whitespace-only SemanticProperties.Description")]
public async Task LayoutPanelDoesNotOptIntoControlViewWhenDescriptionIsWhitespace()
{
SetupLayoutBuilder();

var grid = new Grid();
SemanticProperties.SetDescription(grid, " ");

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.False(peer.IsControlElement());
});
}

[Fact(DisplayName = "LayoutPanel ignores whitespace-only SemanticProperties.Hint")]
public async Task LayoutPanelDoesNotOptIntoControlViewWhenHintIsWhitespace()
{
SetupLayoutBuilder();

var grid = new Grid();
SemanticProperties.SetHint(grid, " ");

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);
Assert.False(peer.IsControlElement());
});
}

[Fact(DisplayName = "LayoutPanel AutomationId is exposed via the peer when set at runtime")]
public async Task LayoutPanelAutomationPeerUpdatesWhenAutomationIdChangesAtRuntime()
{
SetupLayoutBuilder();

var grid = new Grid();

await AttachAndRun(grid, (LayoutHandler handler) =>
{
var peer = FrameworkElementAutomationPeer.CreatePeerForElement(handler.PlatformView);

// Initially no AutomationId.
Assert.Equal(string.Empty, peer.GetAutomationId());

// Set AutomationId at runtime -- peer should reflect the new value.
// Note: MAUI AutomationId is write-once (Element.cs enforces this),
// so we can only test the transition from unset -> set, not set -> cleared.
grid.AutomationId = "DynamicGrid";
Assert.Equal("DynamicGrid", peer.GetAutomationId());
});
}
}
}
Loading
Loading