internal/flutter_availability
5
0
Fork 0
mirror of https://github.com/Iconica-Development/flutter_availability.git synced 2025-05-19 05:03:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: replace the CustomSemantics with the new one from flutter_accessibility

Browse source
This commit is contained in:
Freek van de Ven 2025-03-05 14:17:24 +01:00
parent bf591a45a2
commit d0c7674ea5
20 changed files with 26 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -1,3 +1,7 @@
## 1.1.1
* Removed custom definition of CustomSemantics to use the one from flutter_accessibility instead
## 1.1.0
* Added CustomSemantics widget that is used to wrap all the buttons, textfields and dynamic texts to make the userstory accessible for e2e testing.

2
packages/flutter_availability/lib/src/ui/screens/availability_modification.dart
View file

@ -1,4 +1,5 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/flutter_availability.dart";
import "package:flutter_availability/src/ui/view_models/availability_view_model.dart";
import "package:flutter_availability/src/ui/view_models/break_view_model.dart";
@ -7,7 +8,6 @@ import "package:flutter_availability/src/ui/widgets/availability_template_select
import "package:flutter_availability/src/ui/widgets/availabillity_time_selection.dart";
import "package:flutter_availability/src/ui/widgets/base_page.dart";
import "package:flutter_availability/src/ui/widgets/pause_selection.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability/src/util/utils.dart";
import "package:flutter_hooks/flutter_hooks.dart";

2
packages/flutter_availability/lib/src/ui/screens/availability_overview.dart
View file

@ -1,7 +1,7 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/ui/widgets/base_page.dart";
import "package:flutter_availability/src/ui/widgets/calendar.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/ui/widgets/template_legend.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability_data_interface/flutter_availability_data_interface.dart";

2
packages/flutter_availability/lib/src/ui/screens/template_day_modification.dart
View file

@ -1,10 +1,10 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/service/errors.dart";
import "package:flutter_availability/src/ui/view_models/day_template_view_model.dart";
import "package:flutter_availability/src/ui/view_models/template_daydata_view_model.dart";
import "package:flutter_availability/src/ui/widgets/base_page.dart";
import "package:flutter_availability/src/ui/widgets/color_selection.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/ui/widgets/template_name_input.dart";
import "package:flutter_availability/src/ui/widgets/template_time_break.dart";
import "package:flutter_availability/src/util/scope.dart";

2
packages/flutter_availability/lib/src/ui/screens/template_overview.dart
View file

@ -1,6 +1,6 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/ui/widgets/base_page.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability_data_interface/flutter_availability_data_interface.dart";
import "package:flutter_hooks/flutter_hooks.dart";

2
packages/flutter_availability/lib/src/ui/screens/template_week_modification.dart
View file

@ -1,9 +1,9 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/service/errors.dart";
import "package:flutter_availability/src/ui/view_models/template_daydata_view_model.dart";
import "package:flutter_availability/src/ui/view_models/week_template_view_models.dart";
import "package:flutter_availability/src/ui/widgets/color_selection.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/ui/widgets/template_name_input.dart";
import "package:flutter_availability/src/ui/widgets/template_time_break.dart";
import "package:flutter_availability/src/ui/widgets/template_week_day_selection.dart";

2
packages/flutter_availability/lib/src/ui/widgets/availability_clear.dart
View file

@ -1,5 +1,5 @@
import "package:flutter/material.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/util/scope.dart";
///

2
packages/flutter_availability/lib/src/ui/widgets/availability_template_selection.dart
View file

@ -1,5 +1,5 @@
import "package:flutter/material.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability_data_interface/flutter_availability_data_interface.dart";

2
packages/flutter_availability/lib/src/ui/widgets/calendar.dart
View file

@ -1,7 +1,7 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/flutter_availability.dart";
import "package:flutter_availability/src/ui/widgets/calendar_grid.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
///

2
packages/flutter_availability/lib/src/ui/widgets/calendar_grid.dart
View file

@ -1,6 +1,6 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/flutter_availability.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
/// Returns the days of the week as abbreviated strings

2
packages/flutter_availability/lib/src/ui/widgets/color_selection.dart
View file

@ -1,7 +1,7 @@
import "dart:math";
import "package:flutter/material.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/util/scope.dart";
/// Widget for selecting a color for a template

2
packages/flutter_availability/lib/src/ui/widgets/input_fields.dart
View file

@ -1,6 +1,6 @@
import "package:flutter/material.dart";
import "package:flutter/services.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/util/scope.dart";
/// An input field for time selection

2
packages/flutter_availability/lib/src/ui/widgets/pause_selection.dart
View file

@ -1,10 +1,10 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/flutter_availability.dart";
import "package:flutter_availability/src/service/pop_handler.dart";
import "package:flutter_availability/src/ui/view_models/break_view_model.dart";
import "package:flutter_availability/src/ui/widgets/generic_time_selection.dart";
import "package:flutter_availability/src/ui/widgets/input_fields.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
///

62
packages/flutter_availability/lib/src/ui/widgets/semantic_widget.dart
View file

@ -1,62 +0,0 @@
import "dart:io";
import "package:flutter/foundation.dart";
import "package:flutter/material.dart";
/// A wrapper that wraps a widget with a [Semantics] widget.
/// This is used for testing purposes to add a unique identifier to a widget.
/// Use this element for all widgets that have something that should be
/// selectable in tests (buttons, textfields, dynamic texts)
/// The [identifier] should be unique for the specific screen.
/// To make sure the accessibility ID is set for all platforms this widget
/// uses a label for android when it is not a textfield.
/// [container] is set to true to make sure the widget is always its own
/// accessibility element.
/// [excludeSemantics] is set to false to make sure that children of this widget
/// can still be interacted with.
/// [isTextField] can be set to true because for textField the
/// [excludeSemantics] modifies the behavior of the textfield in e2e tests.
class CustomSemantics extends StatelessWidget {
/// Creates a [CustomSemantics] widget.
/// The [identifier] should be unique for the specific screen.
/// [isTextField] if this widget is a TextField or TextFormField
/// [excludeSemantics] if the [Semantics] widget should exclude the semantics
/// of its children. This is done by default if it not a textfield.
const CustomSemantics({
required this.identifier,
required this.child,
this.excludeSemantics = false,
this.isTextField = false,
super.key,
});
/// The widget that should be wrapped with a [Semantics] widget.
final Widget child;
/// Identifier for the widget that should be unique for the specific screen.
final String? identifier;
/// If the [Semantics] widget should exclude the semantics of its children.
final bool excludeSemantics;
/// If the widget is a textfield, the [child] can't be excluded. This is
/// because otherwise the textfield doesn't work in e2e tests with Appium.
final bool isTextField;
@override
Widget build(BuildContext context) {
var isAndroid = !kIsWeb && Platform.isAndroid;
var excludeSemantics = (!isTextField && isAndroid) || this.excludeSemantics;
var label = !isTextField && isAndroid ? identifier : null;
return Semantics(
excludeSemantics: excludeSemantics,
container: true,
label: label,
identifier: identifier,
child: child,
);
}
}

2
packages/flutter_availability/lib/src/ui/widgets/template_legend.dart
View file

@ -1,6 +1,6 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/config/availability_options.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability_data_interface/flutter_availability_data_interface.dart";

2
packages/flutter_availability/lib/src/ui/widgets/template_name_input.dart
View file

@ -1,5 +1,5 @@
import "package:flutter/material.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/util/scope.dart";
/// Input section for the template name

2
packages/flutter_availability/lib/src/ui/widgets/template_week_day_selection.dart
View file

@ -1,8 +1,8 @@
// ignore_for_file: avoid_positional_boolean_parameters
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/ui/widgets/calendar_grid.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
/// A widget for selecting a day of the week

2
packages/flutter_availability/lib/src/ui/widgets/template_week_overview.dart
View file

@ -1,9 +1,9 @@
import "package:flutter/material.dart";
import "package:flutter_accessibility/flutter_accessibility.dart";
import "package:flutter_availability/src/ui/view_models/break_view_model.dart";
import "package:flutter_availability/src/ui/view_models/template_daydata_view_model.dart";
import "package:flutter_availability/src/ui/view_models/week_template_view_models.dart";
import "package:flutter_availability/src/ui/widgets/calendar_grid.dart";
import "package:flutter_availability/src/ui/widgets/semantic_widget.dart";
import "package:flutter_availability/src/util/scope.dart";
import "package:flutter_availability_data_interface/flutter_availability_data_interface.dart";

7
packages/flutter_availability/pubspec.yaml
View file

@ -1,6 +1,6 @@
name: flutter_availability
description: "Flutter availability userstory package"
version: 1.1.0
version: 1.1.1
publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub
@ -14,7 +14,10 @@ dependencies:
flutter_hooks: ^0.20.5
flutter_availability_data_interface:
hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub
version: ^1.1.0
version: ^1.1.1
flutter_accessibility:
hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub
version: ^0.0.3
dev_dependencies:
flutter_test:

2
packages/flutter_availability_data_interface/pubspec.yaml
View file

@ -1,6 +1,6 @@
name: flutter_availability_data_interface
description: "The data interface for the flutter_availability component"
version: 1.1.0
version: 1.1.1
publish_to: https://forgejo.internal.iconica.nl/api/packages/internal/pub