Files
pipelines/app/lib/ui/input/app_search_field.dart
T
alan ccc80a9a8d Add keyboard navigation to search results
Keep the search field focused while selecting results with Control or arrow keys, and open the selected result with Enter. Document the field-scoped shortcuts and cover navigation, reset, submission, and typing behavior with regression tests.
2026-11-13 15:51:00 +00:00

103 lines
3.1 KiB
Dart

import 'package:flutter/material.dart';
/// The app's one search field.
///
/// A [TextField] shaped like the stock iOS field: a stadium with a leading
/// search icon, a clear button once there is text, no underline and no
/// elevation. On a page it is filled with the host's raised surface; [inBar]
/// drops the fill because a bar's glass pill is already its background.
class AppSearchField extends StatelessWidget {
const AppSearchField({
super.key,
required this.controller,
required this.placeholder,
this.fieldKey,
this.clearKey,
this.onChanged,
this.onSubmitted,
this.onCleared,
this.autofocus = false,
this.focusNode,
this.onKeyEvent,
this.inBar = false,
});
final TextEditingController controller;
final String placeholder;
/// The key of the text field itself, for finders.
final Key? fieldKey;
/// The key of Material's clear button.
final Key? clearKey;
final ValueChanged<String>? onChanged;
final ValueChanged<String>? onSubmitted;
/// Runs after the clear control emptied the field; without it the clear
/// reports an empty [onChanged].
final VoidCallback? onCleared;
final bool autofocus;
final FocusNode? focusNode;
final FocusOnKeyEventCallback? onKeyEvent;
final bool inBar;
void _clear() {
controller.clear();
if (onCleared case final cleared?) {
cleared();
} else {
onChanged?.call('');
}
}
@override
Widget build(BuildContext context) {
final scheme = Theme.of(context).colorScheme;
const radius = BorderRadius.all(Radius.circular(28));
const stadium = OutlineInputBorder(
borderRadius: radius,
borderSide: BorderSide.none,
);
return ValueListenableBuilder<TextEditingValue>(
valueListenable: controller,
builder: (context, value, _) => Focus(
onKeyEvent: onKeyEvent,
child: TextField(
key: fieldKey,
controller: controller,
focusNode: focusNode,
autofocus: autofocus,
textInputAction: TextInputAction.search,
onChanged: onChanged,
onSubmitted: onSubmitted,
decoration: InputDecoration(
hintText: placeholder,
prefixIcon: const Icon(Icons.search),
suffixIcon: value.text.isEmpty
? null
: IconButton(
key: clearKey,
tooltip: 'Clear search',
onPressed: _clear,
icon: const Icon(Icons.close),
),
filled: !inBar,
fillColor: scheme.surfaceContainerHigh,
isDense: true,
border: stadium,
enabledBorder: stadium,
// In the bar the pill is the field's outline; on a page the focused
// field shows the host's focus ring.
focusedBorder: inBar
? stadium
: OutlineInputBorder(
borderRadius: radius,
borderSide: BorderSide(color: scheme.primary, width: 2),
),
),
),
),
);
}
}