Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions changelog.d/+required-field-marker.added.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Required fields carry a red asterisk next to their caption, so a missing entry is visible before pressing the button, and screen readers announce them as required (#414).
24 changes: 23 additions & 1 deletion src/LageBuch.App.Shared/Theme/Styles.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,13 @@
<Setter Property="Template">
<ControlTemplate>
<StackPanel Spacing="2">
<TextBlock Classes="overline" FontSize="10" Text="{TemplateBinding Header}" />
<StackPanel Orientation="Horizontal" Spacing="3">
<TextBlock Classes="overline" FontSize="10" Text="{TemplateBinding Header}" />
<!-- Mandatory marker (#414): shape and colour together, because a colour-only signal
is lost to glare on an ELW screen. Opt in with Classes="field required". -->
<TextBlock x:Name="RequiredMarker" Classes="overline" FontSize="10" Text="*"
IsVisible="False" />
</StackPanel>
<Grid>
<ContentPresenter Content="{TemplateBinding Content}" />
<!-- Suggestion marker (#259): signals the input is backed by a suggestion list
Expand Down Expand Up @@ -532,6 +538,22 @@
<Setter Property="IsVisible" Value="True" />
</Style>

<!-- The asterisk is only seen. A screen reader lands on the input, not on the caption, so the
input itself says it is required. TextBox also covers the one inside an AutoCompleteBox or a
NumericUpDown. -->
<!-- Foreground here rather than on the template part: a value set inside a template ranks
below any style, so TextBlock.overline would repaint the asterisk in caption grey. -->
<Style Selector="HeaderedContentControl.field.required /template/ TextBlock#RequiredMarker">
<Setter Property="IsVisible" Value="True" />
<Setter Property="Foreground" Value="{StaticResource ErrorBrush}" />
</Style>
<Style Selector="HeaderedContentControl.field.required TextBox">
<Setter Property="AutomationProperties.IsRequiredForForm" Value="True" />
</Style>
<Style Selector="HeaderedContentControl.field.required ComboBox">
<Setter Property="AutomationProperties.IsRequiredForForm" Value="True" />
</Style>

<!-- A field the form is waiting on (#412). Set with Classes.invalid from the same error string
that feeds the message, so the input says *which* field while the text says what is needed.
Costs no layout at all, which is the point: in a dense horizontal dock a message under each
Expand Down
2 changes: 1 addition & 1 deletion src/LageBuch.App.Shared/Views/CoMessprotokollView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
Padding="14">
<StackPanel Spacing="8">
<TextBlock Text="NEUES HAUS HINZUFÜGEN" Classes="overline" />
<HeaderedContentControl Classes="field" Header="BEZEICHNUNG"
<HeaderedContentControl Classes="field required" Header="BEZEICHNUNG"
ctrl:Field.Error="{Binding NewBuildingNameError}">
<TextBox x:Name="NewBuildingNameBox" Text="{Binding NewBuildingName}"
PlaceholderText="{x:Static md:AnonymizedExampleData.BuildingNamePlaceholder}" />
Expand Down
4 changes: 2 additions & 2 deletions src/LageBuch.App.Shared/Views/EtbView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
FilterMode="ContainsOrdinal" MinimumPrefixLength="0"
Text="{Binding NewTo}" b:EnterSubmit.Command="{Binding AddEntryCommand}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field" Header="EINTRAG"
<HeaderedContentControl Classes="field required" Header="EINTRAG"
Classes.invalid="{Binding NewTextError, Converter={x:Static ObjectConverters.IsNotNull}}">
<!-- Freitext: kein Platzhalter, siehe #137 -->
<TextBox x:Name="EtbTextBox" Text="{Binding NewText}">
Expand Down Expand Up @@ -172,7 +172,7 @@
IsVisible="{Binding IsEditing}">
<StackPanel Spacing="6">
<StackPanel x:Name="EditFields" Spacing="8">
<HeaderedContentControl Classes="field" Header="EINTRAG"
<HeaderedContentControl Classes="field required" Header="EINTRAG"
Classes.invalid="{Binding EditTextError, Converter={x:Static ObjectConverters.IsNotNull}}">
<!-- Freitext: kein Platzhalter, siehe #137 -->
<TextBox x:Name="EditTextBox" Text="{Binding EditText}">
Expand Down
4 changes: 2 additions & 2 deletions src/LageBuch.App.Shared/Views/ForcesView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@
mutual aid from outside the Landkreis). A suggestion list here would just re-offer
what the dropdown already has. Readonly while a Fahrzeug is selected, since its Wache
derived this field (#215). -->
<HeaderedContentControl Classes="field" Header="FEUERWEHR / WACHE"
<HeaderedContentControl Classes="field required" Header="FEUERWEHR / WACHE"
Classes.invalid="{Binding NewBrigadeError, Converter={x:Static ObjectConverters.IsNotNull}}">
<TextBox x:Name="BrigadeBox"
IsEnabled="{Binding !IsVehicleSelected}"
Expand All @@ -209,7 +209,7 @@
<!-- Same reasoning as Feuerwehr/Wache above: free text for vehicles outside the Stammdaten,
readonly while a Fahrzeug is selected. Required together with the Wache (#220): a
Kraft is a Fahrzeug from den Stammdaten oder eine Wache samt Funkrufname. -->
<HeaderedContentControl Classes="field" Header="FUNKRUFNAME"
<HeaderedContentControl Classes="field required" Header="FUNKRUFNAME"
Classes.invalid="{Binding NewCallSignError, Converter={x:Static ObjectConverters.IsNotNull}}">
<TextBox x:Name="CallSignBox"
IsEnabled="{Binding !IsVehicleSelected}"
Expand Down
2 changes: 1 addition & 1 deletion src/LageBuch.App.Shared/Views/InvolvedPartiesView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</Button>
</Grid>
<StackPanel x:Name="DockFields" Spacing="8">
<HeaderedContentControl Classes="field" Header="NAME"
<HeaderedContentControl Classes="field required" Header="NAME"
Classes.invalid="{Binding NewNameError, Converter={x:Static ObjectConverters.IsNotNull}}">
<TextBox x:Name="NewNameBox"
MaxLength="{x:Static vm:InvolvedPartiesViewModel.MaxNameLength}"
Expand Down
6 changes: 3 additions & 3 deletions src/LageBuch.App.Shared/Views/OperatorPromptView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
requires Tailscale, #59 follow-up), entered alongside "who documents here" so a
joining device provides both in one prompt. -->
<StackPanel IsVisible="{Binding CollectsHost}" Spacing="3">
<HeaderedContentControl Classes="field" Header="GERÄT (NAME ODER IP-ADRESSE)"
<HeaderedContentControl Classes="field required" Header="GERÄT (NAME ODER IP-ADRESSE)"
Margin="0,4,0,0" ctrl:Field.Error="{Binding HostError}">
<TextBox x:Name="HostBox" PlaceholderText="z. B. elw-1 oder 192.168.1.10" Text="{Binding Host}">
<TextBox.KeyBindings>
Expand All @@ -42,7 +42,7 @@
</TextBox>
</HeaderedContentControl>
<!-- The 4-digit PIN the hosting device shows; required to join (#64). -->
<HeaderedContentControl Classes="field" Header="PIN" Margin="0,8,0,0"
<HeaderedContentControl Classes="field required" Header="PIN" Margin="0,8,0,0"
ctrl:Field.Error="{Binding PinError}">
<TextBox x:Name="PinBox" PlaceholderText="4-stellig" MaxLength="4" Text="{Binding Pin}"
b:IntegerOnly.IsEnabled="True">
Expand Down Expand Up @@ -73,7 +73,7 @@
</Border>
</StackPanel>
<!-- Suggests own personnel (#469) but stays free text, like CallSignBox below. -->
<HeaderedContentControl Classes="field suggest" Header="NAME" Margin="0,4,0,0"
<HeaderedContentControl Classes="field suggest required" Header="NAME" Margin="0,4,0,0"
ctrl:Field.Error="{Binding OperatorNameError}">
<AutoCompleteBox x:Name="OperatorNameBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.OperatorFullNamePlaceholder}"
Expand Down
6 changes: 3 additions & 3 deletions src/LageBuch.App.Shared/Views/RolesView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
<!-- Funktion is a suggestion list, not a closed set: an ad-hoc or mutual-aid role must stay
enterable, so this is an AutoCompleteBox rather than a ComboBox (which Avalonia cannot
make editable) — mirrors PersonNameBox below. -->
<HeaderedContentControl Classes="field suggest" Header="FUNKTION"
<HeaderedContentControl Classes="field suggest required" Header="FUNKTION"
Classes.invalid="{Binding NewRoleError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="RoleBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.RolePlaceholder}"
Expand All @@ -147,7 +147,7 @@
MinimumPrefixLength="0"
Text="{Binding NewRole}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field suggest" Header="NAME"
<HeaderedContentControl Classes="field suggest required" Header="NAME"
Classes.invalid="{Binding NewPersonNameError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="PersonNameBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.PersonDisplayNamePlaceholder}"
Expand Down Expand Up @@ -223,7 +223,7 @@
Data="M16.01 11H4v2h12.01v3L20 12l-3.99-4z" />
</StackPanel>
<StackPanel x:Name="TransferFields" Spacing="8">
<HeaderedContentControl Classes="field suggest" Header="NAME"
<HeaderedContentControl Classes="field suggest required" Header="NAME"
Classes.invalid="{Binding TransferPersonNameError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="TransferPersonNameBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.PersonDisplayNamePlaceholder}"
Expand Down
10 changes: 5 additions & 5 deletions src/LageBuch.App.Shared/Views/ScbaView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
MinimumPrefixLength="0"
Text="{Binding NewCallSign}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field" Header="TRUPP-ART"
<HeaderedContentControl Classes="field required" Header="TRUPP-ART"
Classes.invalid="{Binding NewDesignationError, Converter={x:Static ObjectConverters.IsNotNull}}">
<ComboBox x:Name="TruppTypeBox" ItemsSource="{Binding TruppTypeOptions}"
SelectedItem="{Binding NewDesignation}" />
Expand All @@ -143,7 +143,7 @@
selected Trupp-Typ calls for it (#398). Crew names
use the ad-hoc "whoever is entering data right now" persona, not the Stammdaten roster
persona (#137). -->
<HeaderedContentControl Classes="field suggest" Header="TRUPPFÜHRER"
<HeaderedContentControl Classes="field suggest required" Header="TRUPPFÜHRER"
Classes.invalid="{Binding NewTruppfuehrerError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="TruppfuehrerBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.OperatorNamePlaceholder}"
Expand All @@ -152,7 +152,7 @@
Text="{Binding NewTruppfuehrer}"
b:EnterSubmit.Command="{Binding AddTruppCommand}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field suggest" Header="TRUPPMANN"
<HeaderedContentControl Classes="field suggest required" Header="TRUPPMANN"
Classes.invalid="{Binding NewTruppmannError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="TruppmannBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.OperatorNamePlaceholderAlt}"
Expand All @@ -161,7 +161,7 @@
Text="{Binding NewTruppmann}"
b:EnterSubmit.Command="{Binding AddTruppCommand}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field suggest" Header="2. TRUPPMANN" IsVisible="{Binding RequiresThirdMember}"
<HeaderedContentControl Classes="field suggest required" Header="2. TRUPPMANN" IsVisible="{Binding RequiresThirdMember}"
Classes.invalid="{Binding NewZweiterTruppmannError, Converter={x:Static ObjectConverters.IsNotNull}}">
<AutoCompleteBox x:Name="ZweiterTruppmannBox"
PlaceholderText="{x:Static md:AnonymizedExampleData.OperatorNamePlaceholderThird}"
Expand All @@ -170,7 +170,7 @@
Text="{Binding NewZweiterTruppmann}"
b:EnterSubmit.Command="{Binding AddTruppCommand}" />
</HeaderedContentControl>
<HeaderedContentControl Classes="field" Header="EINSTIEGSDRUCK"
<HeaderedContentControl Classes="field required" Header="EINSTIEGSDRUCK"
Classes.invalid="{Binding NewEntryPressureError, Converter={x:Static ObjectConverters.IsNotNull}}">
<StackPanel Orientation="Horizontal" Spacing="6">
<NumericUpDown Width="100" Minimum="1" Maximum="400" Value="{Binding NewEntryPressure}"
Expand Down
2 changes: 1 addition & 1 deletion src/LageBuch.App.Shared/Views/TaskDialogView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
CornerRadius="12,12,0,0" />
<StackPanel Margin="26,22,26,24" Spacing="12">
<TextBlock Text="TASK ERSTELLEN" Classes="display" FontSize="20" />
<HeaderedContentControl Classes="field" Header="AUFGABE" ctrl:Field.Error="{Binding TextError}">
<HeaderedContentControl Classes="field required" Header="AUFGABE" ctrl:Field.Error="{Binding TextError}">
<!-- Freitext: kein Platzhalter, siehe #137 -->
<TextBox x:Name="TaskDialogText" Text="{Binding Text}" AcceptsReturn="False" />
</HeaderedContentControl>
Expand Down
2 changes: 1 addition & 1 deletion src/LageBuch.App.Shared/Views/TasksView.axaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
</TextBox.KeyBindings>
</TextBox>
</HeaderedContentControl>
<HeaderedContentControl Classes="field" Header="AUFGABE"
<HeaderedContentControl Classes="field required" Header="AUFGABE"
Classes.invalid="{Binding NewTextError, Converter={x:Static ObjectConverters.IsNotNull}}">
<!-- Freitext: kein Platzhalter, siehe #137 -->
<TextBox x:Name="TaskNewTextBox" Text="{Binding NewText}">
Expand Down
142 changes: 142 additions & 0 deletions tests/LageBuch.Acceptance.Tests/RequiredFieldMarkerTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
using Avalonia;
using Avalonia.Automation;
using Avalonia.Controls;
using Avalonia.Controls.Primitives;
using Avalonia.Headless;
using Avalonia.Headless.XUnit;
using Avalonia.Media;
using Avalonia.Threading;
using Avalonia.VisualTree;
using LageBuch.App.Shared.Views;
using LageBuch.AppLogic;
using LageBuch.AppLogic.ViewModels;
using LageBuch.Domain;
using LageBuch.Persistence.MasterData;

namespace LageBuch.Acceptance.Tests;

// #414: a required field used to look like every other one until the press that failed on it
// (#412). The asterisk is part of the shared "field" template, switched on by the "required" class,
// so these tests prove the mechanism and pin a few fields that must -- or must not -- carry it.
public class RequiredFieldMarkerTests
{
[AvaloniaFact]
public void Task_dialog_marks_the_task_text_as_required()
{
var (window, view) = ShowTaskDialog();

Assert.True(RequiredMarkerOf(view, "AUFGABE").IsVisible);
Capture(window, "required-task-dialog.png");
}

// The caption style paints every overline grey, and a value set inside a template ranks below
// it -- so an asterisk coloured in the template came out grey and read as punctuation.
[AvaloniaFact]
public void The_asterisk_is_painted_in_the_error_colour_not_the_caption_grey()
{
var (_, view) = ShowTaskDialog();

var expected = Assert.IsAssignableFrom<ISolidColorBrush>(view.FindResource("ErrorBrush"));
var actual = Assert.IsAssignableFrom<ISolidColorBrush>(RequiredMarkerOf(view, "AUFGABE").Foreground);
Assert.Equal(expected.Color, actual.Color);
}

[AvaloniaFact]
public void Task_dialog_leaves_the_optional_fields_unmarked()
{
var (_, view) = ShowTaskDialog();

Assert.False(RequiredMarkerOf(view, "TIMER (MIN)").IsVisible);
Assert.False(RequiredMarkerOf(view, "ZUGETEILT").IsVisible);
}

[AvaloniaFact]
public void A_required_field_tells_assistive_technology_it_is_required()
{
var (_, view) = ShowTaskDialog();

Assert.True(AutomationProperties.GetIsRequiredForForm(view.GetControl<TextBox>("TaskDialogText")));
}

// Everything in the Einsatzdaten dialog is optional on purpose -- a first alarm often has no
// Einsatznummer yet. A marker here would be a lie, so it is guarded rather than just not added.
[AvaloniaFact]
public void Einsatzdaten_dialog_marks_no_field_as_required()
{
var view = new IncidentDataDialogView { DataContext = new IncidentDataDialogViewModel(Session(), () => { }) };
var window = new Window { Content = view, Width = 560, Height = 360 };
window.Show();
Dispatcher.UIThread.RunJobs();

var markers = view.GetVisualDescendants()
.OfType<TextBlock>()
.Where(text => text.Name == "RequiredMarker")
.ToList();
Assert.NotEmpty(markers); // the template part exists ...
Assert.All(markers, marker => Assert.False(marker.IsVisible)); // ... and stays hidden
}

[AvaloniaFact]
public void Forces_dock_marks_wache_and_funkrufname_but_not_the_rest()
{
var vm = new ForcesViewModel(
Session(),
new FixedClock(),
MasterDataSet.Empty with { Vehicles = AnonymizedExampleData.Vehicles },
() => { });
var view = new ForcesView { DataContext = vm };
var window = new Window { Content = view, Width = 1460, Height = 620 };
window.Show();
Dispatcher.UIThread.RunJobs();

Assert.True(RequiredMarkerOf(view, "FEUERWEHR / WACHE").IsVisible);
Assert.True(RequiredMarkerOf(view, "FUNKRUFNAME").IsVisible);
Assert.False(RequiredMarkerOf(view, "STÄRKE ZF / GF / MANN").IsVisible);
Assert.False(RequiredMarkerOf(view, "BEMERKUNG").IsVisible);
Capture(window, "required-forces.png");
}

private static LocalIncidentSession Session() =>
TestSession.StartNew(
new FakeStore(),
new FixedClock(),
new SessionOperator(AnonymizedExampleData.OperatorSurname, "FFB 12/1"),
"/x.fwincident",
Array.Empty<(string, bool)>(),
Array.Empty<(string, bool)>());

private static (Window Window, TaskDialogView View) ShowTaskDialog()
{
var masterData = MasterDataSet.Empty with { Vehicles = AnonymizedExampleData.Vehicles };
var vm = new TaskDialogViewModel(Session(), masterData, string.Empty, () => { });

var view = new TaskDialogView { DataContext = vm };
var window = new Window { Content = view, Width = 560, Height = 360 };
window.Show();
Dispatcher.UIThread.RunJobs();
return (window, view);
}

// The marker belongs to the shared field template, so it is reached through the wrapper whose
// Header names it, the same way FieldErrorRenderTests reaches the message.
private static TextBlock RequiredMarkerOf(Visual root, string header) =>
root.GetVisualDescendants()
.OfType<HeaderedContentControl>()
.Single(field => (field.Header as string) == header)
.GetVisualDescendants()
.OfType<TextBlock>()
.Single(text => text.Name == "RequiredMarker");

private static void Capture(Window window, string name)
{
var dir = Environment.GetEnvironmentVariable("RENDER_OUT");
if (string.IsNullOrWhiteSpace(dir))
{
return;
}

Directory.CreateDirectory(dir);
using var frame = window.CaptureRenderedFrame()!;
frame.SavePng(Path.Join(dir, name));
}
}
Loading