Expose focusNode for HiddenCollectible to improve keyboard UX in the photo_gallery

Improve readability of _handleKeyDown method
This commit is contained in:
Shawn 2024-01-22 15:32:20 -07:00
parent 9d2409cc9d
commit 663ad161fd
3 changed files with 33 additions and 31 deletions

View File

@ -6,7 +6,7 @@ import 'package:wonders/ui/common/utils/app_haptics.dart';
import 'package:wonders/ui/screens/collectible_found/collectible_found_screen.dart'; import 'package:wonders/ui/screens/collectible_found/collectible_found_screen.dart';
class CollectibleItem extends StatelessWidget with GetItMixin { class CollectibleItem extends StatelessWidget with GetItMixin {
CollectibleItem(this.collectible, {this.size = 64.0, Key? key}) : super(key: key) { CollectibleItem(this.collectible, {this.size = 64.0, Key? key, this.focus}) : super(key: key) {
// pre-fetch the image, so it's ready if we show the collectible found screen. // pre-fetch the image, so it's ready if we show the collectible found screen.
_imageProvider = NetworkImage(collectible.imageUrl); _imageProvider = NetworkImage(collectible.imageUrl);
_imageProvider.resolve(ImageConfiguration()).addListener(ImageStreamListener((_, __) {})); _imageProvider.resolve(ImageConfiguration()).addListener(ImageStreamListener((_, __) {}));
@ -15,6 +15,7 @@ class CollectibleItem extends StatelessWidget with GetItMixin {
final CollectibleData collectible; final CollectibleData collectible;
final double size; final double size;
late final ImageProvider _imageProvider; late final ImageProvider _imageProvider;
final FocusNode? focus;
void _handleTap(BuildContext context) async { void _handleTap(BuildContext context) async {
final screen = CollectibleFoundScreen(collectible: collectible, imageProvider: _imageProvider); final screen = CollectibleFoundScreen(collectible: collectible, imageProvider: _imageProvider);
@ -39,6 +40,7 @@ class CollectibleItem extends StatelessWidget with GetItMixin {
// Note: In order for the collapse animation to run properly, we must return a non-zero height or width. // Note: In order for the collapse animation to run properly, we must return a non-zero height or width.
closedBuilder: (_) => SizedBox(width: 1, height: 0), closedBuilder: (_) => SizedBox(width: 1, height: 0),
openBuilder: (_) => AppBtn.basic( openBuilder: (_) => AppBtn.basic(
focusNode: focus,
semanticLabel: $strings.collectibleItemSemanticCollectible, semanticLabel: $strings.collectibleItemSemanticCollectible,
onPressed: () => _handleTap(context), onPressed: () => _handleTap(context),
enableFeedback: false, enableFeedback: false,

View File

@ -5,13 +5,15 @@ import 'package:wonders/ui/common/collectible_item.dart';
/// The item is looked up via index, and expects that 3 items always exist for each wonder. /// The item is looked up via index, and expects that 3 items always exist for each wonder.
/// If `wonders` is empty, then the collectible is always shown. /// If `wonders` is empty, then the collectible is always shown.
class HiddenCollectible extends StatelessWidget with GetItMixin { class HiddenCollectible extends StatelessWidget with GetItMixin {
HiddenCollectible(this.currentWonder, {Key? key, required this.index, this.matches = const [], this.size = 64}) HiddenCollectible(this.currentWonder,
{Key? key, required this.index, this.matches = const [], this.size = 64, this.focus})
: assert(index <= 2, 'index should not exceed 2'), : assert(index <= 2, 'index should not exceed 2'),
super(key: key); super(key: key);
final int index; final int index;
final double size; final double size;
final List<WonderType> matches; final List<WonderType> matches;
final WonderType currentWonder; final WonderType currentWonder;
final FocusNode? focus;
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) {
final data = collectiblesLogic.forWonder(currentWonder); final data = collectiblesLogic.forWonder(currentWonder);
@ -19,6 +21,6 @@ class HiddenCollectible extends StatelessWidget with GetItMixin {
if (matches.isNotEmpty && matches.contains(currentWonder) == false) { if (matches.isNotEmpty && matches.contains(currentWonder) == false) {
return SizedBox.shrink(); return SizedBox.shrink();
} }
return CollectibleItem(data[index], size: size); return CollectibleItem(data[index], size: size, focus: focus);
} }
} }

View File

@ -99,8 +99,6 @@ class _PhotoGalleryState extends State<PhotoGallery> {
} }
bool _handleKeyDown(KeyDownEvent event) { bool _handleKeyDown(KeyDownEvent event) {
var newIndex = -1;
bool handled = false;
final key = event.logicalKey; final key = event.logicalKey;
Map<LogicalKeyboardKey, int> keyActions = { Map<LogicalKeyboardKey, int> keyActions = {
LogicalKeyboardKey.arrowUp: -_gridSize, LogicalKeyboardKey.arrowUp: -_gridSize,
@ -109,24 +107,22 @@ class _PhotoGalleryState extends State<PhotoGallery> {
LogicalKeyboardKey.arrowLeft: -1, LogicalKeyboardKey.arrowLeft: -1,
}; };
int? action = keyActions[key]; // Apply key action, exit early if no action is defined
if (action != null) { int? actionValue = keyActions[key];
newIndex = _index + action; if (actionValue == null) return false;
handled = true; int newIndex = _index + actionValue;
// Block actions along edges of the grid
bool isRightSide = _index % _gridSize == _gridSize - 1; bool isRightSide = _index % _gridSize == _gridSize - 1;
if (isRightSide && key == LogicalKeyboardKey.arrowRight) {
newIndex = -1;
}
bool isLeftSide = _index % _gridSize == 0; bool isLeftSide = _index % _gridSize == 0;
if (isLeftSide && key == LogicalKeyboardKey.arrowLeft) newIndex = -1; bool outOfBounds = newIndex < 0 || newIndex >= _imgCount;
if (newIndex > _gridSize * _gridSize) { if ((isRightSide && key == LogicalKeyboardKey.arrowRight) ||
newIndex = -1; (isLeftSide && key == LogicalKeyboardKey.arrowLeft) ||
outOfBounds) {
return false;
} }
if (newIndex >= 0) {
_setIndex(newIndex); _setIndex(newIndex);
} return true;
}
return handled;
} }
/// Converts a swipe direction into a new index /// Converts a swipe direction into a new index
@ -274,14 +270,16 @@ class _PhotoGalleryState extends State<PhotoGallery> {
liveRegion: isSelected, liveRegion: isSelected,
onIncrease: () => _handleImageTapped(_index + 1, false), onIncrease: () => _handleImageTapped(_index + 1, false),
onDecrease: () => _handleImageTapped(_index - 1, false), onDecrease: () => _handleImageTapped(_index - 1, false),
child: AppBtn.basic( child: _checkCollectibleIndex(index)
? Center(
child: HiddenCollectible(widget.wonderType, index: 1, size: 100, focus: _focusNodes[index]),
)
: AppBtn.basic(
semanticLabel: semanticLbl, semanticLabel: semanticLbl,
focusNode: _focusNodes[index], focusNode: _focusNodes[index],
onFocusChanged: (isFocused) => _handleImageFocusChanged(index, isFocused), onFocusChanged: (isFocused) => _handleImageFocusChanged(index, isFocused),
onPressed: () => _handleImageTapped(index, isSelected), onPressed: () => _handleImageTapped(index, isSelected),
child: _checkCollectibleIndex(index) child: ClipRRect(
? Center(child: HiddenCollectible(widget.wonderType, index: 1, size: 100))
: ClipRRect(
borderRadius: BorderRadius.circular(8), borderRadius: BorderRadius.circular(8),
child: SizedBox( child: SizedBox(
width: imgSize.width, width: imgSize.width,