Browse Source

Make the keyboard work inside a picker popup (#22489)

* Add keyboard tests for the pickers

* Make the keyboard work inside a picker popup

* Only tab through picker columns that are on screen

Use IsEffectivelyVisible cause a column can be IsVisible while off screen. We don't loop over things that the user cannot see.

* Open a picker popup without claiming the pointer moved focus

* Move the tests to proper place

* Pass the test cancellation token when running dispatcher jobs
pull/22562/head
Evan 4 weeks ago
committed by GitHub
parent
commit
e7cd2df08e
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 7
      src/Avalonia.Controls/CalendarDatePicker/CalendarDatePicker.cs
  2. 3
      src/Avalonia.Controls/DateTimePickers/DatePicker.cs
  3. 39
      src/Avalonia.Controls/DateTimePickers/DatePickerPresenter.cs
  4. 3
      src/Avalonia.Controls/DateTimePickers/TimePicker.cs
  5. 29
      src/Avalonia.Controls/DateTimePickers/TimePickerPresenter.cs
  6. 58
      tests/Avalonia.Controls.UnitTests/CalendarDatePickerTests.cs
  7. 104
      tests/Avalonia.Controls.UnitTests/DatePickerTests.cs
  8. 105
      tests/Avalonia.Controls.UnitTests/TimePickerTests.cs

7
src/Avalonia.Controls/CalendarDatePicker/CalendarDatePicker.cs

@ -120,6 +120,10 @@ namespace Avalonia.Controls
{
_calendar.SelectionMode = CalendarSelectionMode.SingleDate;
// The calendar handles the arrow keys itself, so the drop-down gives it the focus without putting it in the tab order.
_calendar.Focusable = true;
_calendar.IsTabStop = false;
_calendar.DayButtonMouseUp += Calendar_DayButtonMouseUp;
_calendar.DisplayDateChanged += Calendar_DisplayDateChanged;
_calendar.SelectedDatesChanged += Calendar_SelectedDatesChanged;
@ -701,8 +705,6 @@ namespace Avalonia.Controls
{
if (_calendar != null)
{
_calendar.Focus();
// Open the PopUp
_onOpenSelectedDate = SelectedDate;
_popUp!.IsOpen = true;
@ -710,6 +712,7 @@ namespace Avalonia.Controls
UpdatePseudoClasses();
_calendar.ResetStates();
_calendar.Focus();
OnCalendarOpened(new RoutedEventArgs());
}
}

3
src/Avalonia.Controls/DateTimePickers/DatePicker.cs

@ -426,6 +426,9 @@ namespace Avalonia.Controls
// The extra 5 px I think is related to default popup placement behavior
_popup.VerticalOffset = deltaY + 5;
// Focus only lands once the popup is open, so the selectors take the arrow keys.
_presenter.SetInitialFocus();
}
protected virtual void OnSelectedDateChanged(object? sender, DatePickerSelectedValueChangedEventArgs e)

39
src/Avalonia.Controls/DateTimePickers/DatePickerPresenter.cs

@ -351,7 +351,8 @@ namespace Avalonia.Controls
var focusManager = FocusManager.GetFocusManager(this);
if (focusManager?.GetFocusedElement() is { } focus)
{
var nextFocus = KeyboardNavigationHandler.GetNext(focus, NavigationDirection.Next);
var direction = e.Key.ToNavigationDirection(e.KeyModifiers) ?? NavigationDirection.Next;
var nextFocus = KeyboardNavigationHandler.GetNext(focus, direction);
nextFocus?.Focus(NavigationMethod.Tab);
e.Handled = true;
}
@ -416,6 +417,39 @@ namespace Avalonia.Controls
SetInitialFocus(items);
}
// The culture decides which column comes first, so tab follows the columns on screen rather than the template.
private static void SetTabOrder(TemplateItems items)
{
ReadOnlySpan<(Panel host, DateTimePickerPanel selector)> selectors =
[
(items._monthHost, items._monthSelector),
(items._dayHost, items._daySelector),
(items._yearHost, items._yearSelector),
];
var tabIndex = 1;
for (var column = 0; column < selectors.Length * 2; column++)
{
foreach (var (host, selector) in selectors)
{
if (host.IsVisible && Grid.GetColumn(host) == column)
selector.TabIndex = tabIndex++;
}
}
items._acceptButton.TabIndex = tabIndex++;
if (items._dismissButton is { } dismissButton)
dismissButton.TabIndex = tabIndex;
}
internal void SetInitialFocus()
{
if (_templateItems is { } items)
SetInitialFocus(items);
}
private void SetGrid(TemplateItems items)
{
var fmt = CultureInfo.CurrentCulture.DateTimeFormat.ShortDatePattern;
@ -459,6 +493,7 @@ namespace Avalonia.Controls
ConfigureSpacer(items._firstSpacer, columnIndex > 1, 1);
ConfigureSpacer(items._secondSpacer, columnIndex > 2, 3);
SetTabOrder(items);
return;
static void ConfigureSpacer(Control? spacer, bool visible, int column)
@ -496,7 +531,7 @@ namespace Avalonia.Controls
}
}
leftmost?.Focus(NavigationMethod.Pointer);
leftmost?.Focus(NavigationMethod.Unspecified);
}
private void OnDismissButtonClicked(object? sender, RoutedEventArgs e)

3
src/Avalonia.Controls/DateTimePickers/TimePicker.cs

@ -401,6 +401,9 @@ namespace Avalonia.Controls
// The extra 5 px I think is related to default popup placement behavior
_popup.VerticalOffset = deltaY + 5;
// Focus only lands once the popup is open, so the selectors take the arrow keys.
_presenter.SetInitialFocus();
}
private void OnDismissPicker(object? sender, EventArgs e)

29
src/Avalonia.Controls/DateTimePickers/TimePickerPresenter.cs

@ -244,7 +244,8 @@ namespace Avalonia.Controls
case Key.Tab:
if (FocusManager.GetFocusManager(this)?.GetFocusedElement() is { } focus)
{
var nextFocus = KeyboardNavigationHandler.GetNext(focus, NavigationDirection.Next);
var direction = e.Key.ToNavigationDirection(e.KeyModifiers) ?? NavigationDirection.Next;
var nextFocus = KeyboardNavigationHandler.GetNext(focus, direction);
nextFocus?.Focus(NavigationMethod.Tab);
e.Handled = true;
}
@ -309,7 +310,13 @@ namespace Avalonia.Controls
items._periodSelector.SelectedValue = hr >= 12 ? 1 : 0;
SetGrid(items);
items._hourSelector.Focus(NavigationMethod.Pointer);
items._hourSelector.Focus(NavigationMethod.Unspecified);
}
internal void SetInitialFocus()
{
if (_templateItems is { } items)
items._hourSelector.Focus(NavigationMethod.Unspecified);
}
private void SetGrid(TemplateItems items)
@ -358,6 +365,24 @@ namespace Avalonia.Controls
}
items._pickerContainer.ColumnDefinitions = columnsD;
SetTabOrder(items);
}
private static void SetTabOrder(TemplateItems items)
{
var tabIndex = 1;
items._hourSelector.TabIndex = tabIndex++;
items._minuteSelector.TabIndex = tabIndex++;
if (items._secondSelector is { } secondSelector)
secondSelector.TabIndex = tabIndex++;
items._periodSelector.TabIndex = tabIndex++;
items._acceptButton.TabIndex = tabIndex++;
if (items._dismissButton is { } dismissButton)
dismissButton.TabIndex = tabIndex;
}
private void OnDismissButtonClicked(object? sender, RoutedEventArgs e)

58
tests/Avalonia.Controls.UnitTests/CalendarDatePickerTests.cs

@ -11,6 +11,9 @@ using Avalonia.UnitTests;
using Moq;
using Xunit;
using System.Globalization;
using Avalonia.Threading;
using Avalonia.VisualTree;
using Avalonia.Interactivity;
namespace Avalonia.Controls.UnitTests
{
@ -424,5 +427,60 @@ namespace Avalonia.Controls.UnitTests
}
}
[Fact]
public void Opening_The_DropDown_Should_Focus_The_Calendar()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new CalendarDatePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
picker.IsDropDownOpen = true;
Dispatcher.UIThread.RunJobs(null, TestContext.Current.CancellationToken);
Assert.True(GetCalendar(picker).IsFocused);
}
[Fact]
public void Escape_Should_Put_The_Date_Back()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var chosen = new DateTime(2026, 5, 15);
var picker = new CalendarDatePicker { SelectedDate = chosen };
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
picker.IsDropDownOpen = true;
Dispatcher.UIThread.RunJobs(null, TestContext.Current.CancellationToken);
var calendar = GetCalendar(picker);
Press(calendar, Key.Down);
Assert.NotEqual(chosen, picker.SelectedDate);
Press(calendar, Key.Escape);
Assert.Equal(chosen, picker.SelectedDate);
Assert.False(picker.IsDropDownOpen);
}
private static Calendar GetCalendar(CalendarDatePicker picker)
{
var popup = picker.GetVisualDescendants().OfType<Popup>().First();
return popup.Child!.GetSelfAndVisualDescendants().OfType<Calendar>().First();
}
private static void Press(Control target, Key key)
{
target.RaiseEvent(new KeyEventArgs { RoutedEvent = InputElement.KeyDownEvent, Key = key });
Dispatcher.UIThread.RunJobs();
}
}
}

104
tests/Avalonia.Controls.UnitTests/DatePickerTests.cs

@ -16,6 +16,8 @@ using Avalonia.VisualTree;
using Avalonia.Layout;
using Moq;
using Xunit;
using System.Collections.Generic;
using Avalonia.Interactivity;
namespace Avalonia.Controls.UnitTests
{
@ -494,5 +496,107 @@ namespace Avalonia.Controls.UnitTests
return contentPanel;
});
}
[Fact]
public void Opening_The_Popup_Should_Focus_A_Selector()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new DatePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
Assert.Contains(VisibleSelectors(picker), selector => selector.IsFocused);
}
[Fact]
public void Tab_Should_Follow_The_Columns_On_Screen()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new DatePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
var selectors = VisibleSelectors(picker);
var leftToRight = LeftToRight(picker, selectors);
var visited = new List<DateTimePickerPanel> { Focused(selectors) };
for (var i = 1; i < leftToRight.Length; i++)
{
Tab(selectors, KeyModifiers.None);
visited.Add(Focused(selectors));
}
Assert.Equal(leftToRight, visited);
}
[Fact]
public void Shift_Tab_Should_Go_Back_Through_The_Columns()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new DatePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
var selectors = VisibleSelectors(picker);
var first = Focused(selectors);
Tab(selectors, KeyModifiers.None);
Assert.NotSame(first, Focused(selectors));
Tab(selectors, KeyModifiers.Shift);
Assert.Same(first, Focused(selectors));
}
private static void Open(Control picker)
{
var button = picker.GetVisualDescendants().OfType<Button>().First(b => b.Name == "PART_FlyoutButton");
button.RaiseEvent(new RoutedEventArgs(Button.ClickEvent));
Dispatcher.UIThread.RunJobs();
}
private static DateTimePickerPanel[] VisibleSelectors(Control picker)
{
var popup = picker.GetVisualDescendants().OfType<Popup>().First();
return popup.Child is { } content
? content.GetSelfAndVisualDescendants().OfType<DateTimePickerPanel>()
.Where(selector => selector.IsEffectivelyVisible).ToArray()
: [];
}
private static DateTimePickerPanel[] LeftToRight(Control picker, DateTimePickerPanel[] selectors)
{
var content = (Visual)picker.GetVisualDescendants().OfType<Popup>().First().Child!;
return selectors.OrderBy(selector => selector.TranslatePoint(new Point(), content)?.X ?? 0).ToArray();
}
private static DateTimePickerPanel Focused(DateTimePickerPanel[] selectors)
=> selectors.First(selector => selector.IsFocused);
private static void Tab(DateTimePickerPanel[] selectors, KeyModifiers modifiers)
{
Focused(selectors).RaiseEvent(new KeyEventArgs
{
RoutedEvent = InputElement.KeyDownEvent,
Key = Key.Tab,
KeyModifiers = modifiers
});
Dispatcher.UIThread.RunJobs();
}
}
}

105
tests/Avalonia.Controls.UnitTests/TimePickerTests.cs

@ -14,6 +14,9 @@ using Avalonia.VisualTree;
using Avalonia.Layout;
using Moq;
using Xunit;
using System.Collections.Generic;
using Avalonia.Interactivity;
using Avalonia.Input;
namespace Avalonia.Controls.UnitTests
{
@ -485,5 +488,107 @@ namespace Avalonia.Controls.UnitTests
var timePicker = new TimePicker();
Assert.Equal(Avalonia.Layout.VerticalAlignment.Stretch, timePicker.VerticalContentAlignment);
}
[Fact]
public void Opening_The_Popup_Should_Focus_A_Selector()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new TimePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
Assert.Contains(VisibleSelectors(picker), selector => selector.IsFocused);
}
[Fact]
public void Tab_Should_Follow_The_Columns_On_Screen()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new TimePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
var selectors = VisibleSelectors(picker);
var leftToRight = LeftToRight(picker, selectors);
var visited = new List<DateTimePickerPanel> { Focused(selectors) };
for (var i = 1; i < leftToRight.Length; i++)
{
Tab(selectors, KeyModifiers.None);
visited.Add(Focused(selectors));
}
Assert.Equal(leftToRight, visited);
}
[Fact]
public void Shift_Tab_Should_Go_Back_Through_The_Columns()
{
using var app = UnitTestApplication.Start(TestServices.FocusableWindow);
var picker = new TimePicker();
var window = new Window { Content = picker };
window.Show();
window.LayoutManager.ExecuteInitialLayoutPass();
Open(picker);
var selectors = VisibleSelectors(picker);
var first = Focused(selectors);
Tab(selectors, KeyModifiers.None);
Assert.NotSame(first, Focused(selectors));
Tab(selectors, KeyModifiers.Shift);
Assert.Same(first, Focused(selectors));
}
private static void Open(Control picker)
{
var button = picker.GetVisualDescendants().OfType<Button>().First(b => b.Name == "PART_FlyoutButton");
button.RaiseEvent(new RoutedEventArgs(Button.ClickEvent));
Dispatcher.UIThread.RunJobs();
}
private static DateTimePickerPanel[] VisibleSelectors(Control picker)
{
var popup = picker.GetVisualDescendants().OfType<Popup>().First();
return popup.Child is { } content
? content.GetSelfAndVisualDescendants().OfType<DateTimePickerPanel>()
.Where(selector => selector.IsEffectivelyVisible).ToArray()
: [];
}
private static DateTimePickerPanel[] LeftToRight(Control picker, DateTimePickerPanel[] selectors)
{
var content = (Visual)picker.GetVisualDescendants().OfType<Popup>().First().Child!;
return selectors.OrderBy(selector => selector.TranslatePoint(new Point(), content)?.X ?? 0).ToArray();
}
private static DateTimePickerPanel Focused(DateTimePickerPanel[] selectors)
=> selectors.First(selector => selector.IsFocused);
private static void Tab(DateTimePickerPanel[] selectors, KeyModifiers modifiers)
{
Focused(selectors).RaiseEvent(new KeyEventArgs
{
RoutedEvent = InputElement.KeyDownEvent,
Key = Key.Tab,
KeyModifiers = modifiers
});
Dispatcher.UIThread.RunJobs();
}
}
}

Loading…
Cancel
Save