Skip to content

fix(a11y): focus ring and state semantics for QueryaIconButton #1395

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

Merged
ZhuchkaTriplesix merged 1 commit into from
Oct 10, 2026
Merged

fix(a11y): focus ring and state semantics for QueryaIconButton #1395

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
105 changes: 82 additions & 23 deletions lib/shared/widgets/querya_icon_button.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ enum QueryaIconButtonDensity {
}

/// Standard icon button with density presets, hover/active states, and built-in tooltip.
class QueryaIconButton extends material.StatelessWidget {
class QueryaIconButton extends material.StatefulWidget {
const QueryaIconButton({
super.key,
required this.icon,
Expand Down Expand Up @@ -59,11 +59,27 @@ class QueryaIconButton extends material.StatelessWidget {
/// Custom border radius. Defaults to 6px.
final material.BorderRadius? borderRadius;

@override
material.State<QueryaIconButton> createState() => _QueryaIconButtonState();
}

class _QueryaIconButtonState extends material.State<QueryaIconButton> {
/// Whether the button has keyboard focus (#1370): drawn as a 2px ring.
bool _focused = false;

@override
material.Widget build(material.BuildContext context) {
final icon = widget.icon;
final tooltip = widget.tooltip;
final onPressed = widget.onPressed;
final density = widget.density;
final isActive = widget.isActive;
final isDestructive = widget.isDestructive;
final color = widget.color;
final activeColor = widget.activeColor;
final cs = Theme.of(context).colorScheme;
final workbench = QueryaThemeScope.maybeOf(context)?.workbench;
final radius = borderRadius ?? material.BorderRadius.circular(6);
final radius = widget.borderRadius ?? material.BorderRadius.circular(6);

final isEnabled = onPressed != null;

Expand Down Expand Up @@ -98,19 +114,25 @@ class QueryaIconButton extends material.StatelessWidget {
color: effectiveBgColor ?? material.Colors.transparent,
shape: material.RoundedRectangleBorder(
borderRadius: radius,
side: isActive
? material.BorderSide(
color: (isDestructive ? destructiveColor : accentColor)
.withValues(alpha: 0.3),
width: 1,
)
: material.BorderSide.none,
side: _focused
? material.BorderSide(color: cs.ring, width: 2)
: isActive
? material.BorderSide(
color: (isDestructive ? destructiveColor : accentColor)
.withValues(alpha: 0.3),
width: 1,
)
: material.BorderSide.none,
),
clipBehavior: material.Clip.antiAlias,
child: material.InkWell(
onTap: onPressed,
onFocusChange: (focused) {
if (_focused != focused) setState(() => _focused = focused);
},
borderRadius: radius,
hoverColor: hoverColor,
focusColor: material.Colors.transparent,
splashColor: (isDestructive ? destructiveColor : accentColor)
.withValues(alpha: 0.2),
child: material.SizedBox(
Expand All @@ -131,9 +153,16 @@ class QueryaIconButton extends material.StatelessWidget {
),
);

if (tooltip != null && tooltip!.isNotEmpty) {
button = material.Semantics(
button: true,
enabled: onPressed != null,
selected: isActive,
child: button,
);

if (tooltip != null && tooltip.isNotEmpty) {
button = material.Tooltip(
message: tooltip!,
message: tooltip,
waitDuration: kQueryaTooltipWait,
child: button,
);
Expand All @@ -144,7 +173,7 @@ class QueryaIconButton extends material.StatelessWidget {
}

/// Standard toolbar button with optional leading icon, label, and shortcut hint.
class QueryaToolbarButton extends material.StatelessWidget {
class QueryaToolbarButton extends material.StatefulWidget {
const QueryaToolbarButton({
super.key,
required this.label,
Expand All @@ -166,8 +195,25 @@ class QueryaToolbarButton extends material.StatelessWidget {
final bool isActive;
final bool isDestructive;

@override
material.State<QueryaToolbarButton> createState() =>
_QueryaToolbarButtonState();
}

class _QueryaToolbarButtonState extends material.State<QueryaToolbarButton> {
/// Whether the button has keyboard focus (#1370): drawn as a 2px ring.
bool _focused = false;

@override
material.Widget build(material.BuildContext context) {
final label = widget.label;
final icon = widget.icon;
final tooltip = widget.tooltip;
final shortcutHint = widget.shortcutHint;
final onPressed = widget.onPressed;
final density = widget.density;
final isActive = widget.isActive;
final isDestructive = widget.isDestructive;
final cs = Theme.of(context).colorScheme;
final workbench = QueryaThemeScope.maybeOf(context)?.workbench;
final isEnabled = onPressed != null;
Expand Down Expand Up @@ -202,7 +248,7 @@ class QueryaToolbarButton extends material.StatelessWidget {
size: density.iconSize,
color: effectiveFgColor,
),
child: icon!,
child: icon,
),
const Gap(6),
],
Expand All @@ -223,7 +269,7 @@ class QueryaToolbarButton extends material.StatelessWidget {
borderRadius: material.BorderRadius.circular(3),
),
child: material.Text(
shortcutHint!,
shortcutHint,
style: material.TextStyle(
fontSize: 9,
fontWeight: material.FontWeight.w500,
Expand All @@ -239,19 +285,25 @@ class QueryaToolbarButton extends material.StatelessWidget {
color: effectiveBgColor,
shape: material.RoundedRectangleBorder(
borderRadius: radius,
side: isActive
? material.BorderSide(
color: (isDestructive ? destructiveColor : accentColor)
.withValues(alpha: 0.3),
width: 1,
)
: material.BorderSide.none,
side: _focused
? material.BorderSide(color: cs.ring, width: 2)
: isActive
? material.BorderSide(
color: (isDestructive ? destructiveColor : accentColor)
.withValues(alpha: 0.3),
width: 1,
)
: material.BorderSide.none,
),
clipBehavior: material.Clip.antiAlias,
child: material.InkWell(
onTap: onPressed,
onFocusChange: (focused) {
if (_focused != focused) setState(() => _focused = focused);
},
borderRadius: radius,
hoverColor: hoverColor,
focusColor: material.Colors.transparent,
child: material.Container(
height: density.boxSize,
padding: material.EdgeInsets.symmetric(
Expand All @@ -263,9 +315,16 @@ class QueryaToolbarButton extends material.StatelessWidget {
),
);

if (tooltip != null && tooltip!.isNotEmpty) {
button = material.Semantics(
button: true,
enabled: onPressed != null,
selected: isActive,
child: button,
);

if (tooltip != null && tooltip.isNotEmpty) {
button = material.Tooltip(
message: tooltip!,
message: tooltip,
waitDuration: kQueryaTooltipWait,
child: button,
);
Expand Down
85 changes: 85 additions & 0 deletions test/shared/widgets/querya_icon_button_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,91 @@ void main() {
expect(box.width, 32);
expect(box.height, 32);
});

testWidgets('draws a 2px focus ring while it has keyboard focus (#1370)',
(tester) async {
await tester.pumpWidget(
queryaThemeTestShell(
child: QueryaIconButton(
icon: const material.Icon(material.Icons.refresh),
onPressed: () {},
),
),
);

final materialFinder = find
.descendant(
of: find.byType(QueryaIconButton),
matching: find.byType(material.Material),
)
.first;
final inkFinder = find.descendant(
of: find.byType(QueryaIconButton),
matching: find.byType(material.InkWell),
);
double ringWidth() {
final shape =
tester.widget<material.Material>(materialFinder).shape!
as material.RoundedRectangleBorder;
return shape.side.width;
}

expect(ringWidth(), 0);

tester.widget<material.InkWell>(inkFinder).onFocusChange!(true);
await tester.pump();
expect(ringWidth(), 2);

tester.widget<material.InkWell>(inkFinder).onFocusChange!(false);
await tester.pump();
expect(ringWidth(), 0);
});

testWidgets('exposes button, enabled and selected state (#1370)',
(tester) async {
await tester.pumpWidget(
queryaThemeTestShell(
child: QueryaIconButton(
icon: const material.Icon(material.Icons.wrap_text),
tooltip: 'Word wrap',
isActive: true,
onPressed: () {},
),
),
);

expect(
find.byWidgetPredicate(
(w) =>
w is material.Semantics &&
w.properties.button == true &&
w.properties.enabled == true &&
w.properties.selected == true,
),
findsWidgets,
);
});

testWidgets('a button without a callback is exposed as disabled (#1370)',
(tester) async {
await tester.pumpWidget(
queryaThemeTestShell(
child: const QueryaIconButton(
icon: material.Icon(material.Icons.refresh),
),
),
);

expect(
find.byWidgetPredicate(
(w) =>
w is material.Semantics &&
w.properties.button == true &&
w.properties.enabled == false,
),
findsWidgets,
);
});
});

group('QueryaToolbarButton', () {
Expand Down
Loading