π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
[mobile] Add loading component and dialog to ente_components (#13634)
aman-pilot4379338a6d5c
diff --git a/mobile/packages/ente_components/example/lib/main.dart b/mobile/packages/ente_components/example/lib/main.dartindex bc97609c0c..5e4d2befe0 100644--- a/mobile/packages/ente_components/example/lib/main.dart+++ b/mobile/packages/ente_components/example/lib/main.dart@@ -251,6 +251,12 @@ class _CatalogHomeState extends State<CatalogHome> {components: const ['Button', 'Icon button'],previewBuilder: (_) => const _ButtonMatrix(),),+ CatalogSection(+ title: 'Loading',+ icon: HugeIcons.strokeRoundedLoading03,+ components: const ['Indicator', 'Dialog'],+ previewBuilder: (_) => const _LoadingPreview(),+ ),CatalogSection(title: 'Floating action button',icon: HugeIcons.strokeRoundedAdd01,@@ -4207,3 +4213,90 @@ class _WarningIllustration extends StatelessWidget {return Image.asset('assets/warning-grey.png', width: 101, height: 89);}}++class _LoadingPreview extends StatefulWidget {+ const _LoadingPreview();++ @override+ State<_LoadingPreview> createState() => _LoadingPreviewState();+}++class _LoadingPreviewState extends State<_LoadingPreview> {+ Future<void> _showDialog() async {+ final dialog = showLoadingComponent(context, 'Deleting 3 items');+ await Future<void>.delayed(const Duration(milliseconds: 1500));+ dialog.update(message: 'Almost done');+ await Future<void>.delayed(const Duration(milliseconds: 1500));+ await dialog.hide();+ }++ Future<void> _showProgress() async {+ final dialog = showLoadingComponent(+ context,+ 'Opening Passport scan.pdf',+ isDismissible: true,+ );+ for (var step = 1; step <= 30; step++) {+ await Future<void>.delayed(const Duration(milliseconds: 100));+ dialog.update(message: 'Downloading ${(step / 30 * 100).round()}%');+ }+ await dialog.hide();+ }++ @override+ Widget build(BuildContext context) {+ return _CatalogPreviewList(+ children: [+ _CatalogPreviewGroup(+ title: 'Indicator',+ child: Row(+ mainAxisAlignment: MainAxisAlignment.spaceAround,+ children: [+ for (final size in LoadingComponentSize.values)+ _LoadingSample(+ label: size.name,+ child: LoadingComponent(size: size),+ ),+ ],+ ),+ ),+ _CatalogPreviewGroup(+ title: 'Dialog (tap to show)',+ child: Column(+ children: [+ _ToastTriggerButton(label: 'Show dialog', onTap: _showDialog),+ const SizedBox(height: Spacing.sm),+ _ToastTriggerButton(+ label: 'Show dialog with progress (tap to dismiss)',+ onTap: _showProgress,+ ),+ ],+ ),+ ),+ ],+ );+ }+}++class _LoadingSample extends StatelessWidget {+ const _LoadingSample({required this.label, required this.child});++ final String label;+ final Widget child;++ @override+ Widget build(BuildContext context) {+ final colors = context.componentColors;+ return Column(+ mainAxisSize: MainAxisSize.min,+ children: [+ SizedBox(+ height: LoadingComponentSize.large.diameter,+ child: Center(child: child),+ ),+ const SizedBox(height: Spacing.md),+ Text(label, style: TextStyles.mini.copyWith(color: colors.textLight)),+ ],+ );+ }+}diff --git a/mobile/packages/ente_components/lib/components/loading/loading_component.dart b/mobile/packages/ente_components/lib/components/loading/loading_component.dartnew file mode 100644index 0000000000..3b8f18c796--- /dev/null+++ b/mobile/packages/ente_components/lib/components/loading/loading_component.dart@@ -0,0 +1,103 @@+import 'dart:math' as math;+import 'dart:ui' show SemanticsRole;++import 'package:ente_components/theme/theme.dart';+import 'package:flutter/material.dart';++enum LoadingComponentSize {+ small(16, 2),+ medium(24, 2.5),+ large(40, 3);++ const LoadingComponentSize(this.diameter, this.stroke);++ final double diameter;+ final double stroke;+}++class LoadingComponent extends StatefulWidget {+ const LoadingComponent({+ super.key,+ this.size = LoadingComponentSize.medium,+ this.color,+ this.semanticsLabel,+ });++ final LoadingComponentSize size;+ final Color? color;+ final String? semanticsLabel;++ @override+ State<LoadingComponent> createState() => _LoadingComponentState();+}++class _LoadingComponentState extends State<LoadingComponent>+ with SingleTickerProviderStateMixin {+ late final _turn = AnimationController(+ vsync: this,+ duration: const Duration(seconds: 1),+ );++ @override+ void initState() {+ super.initState();+ _turn.repeat();+ }++ @override+ void dispose() {+ _turn.dispose();+ super.dispose();+ }++ @override+ Widget build(BuildContext context) {+ return Semantics(+ label: widget.semanticsLabel,+ role: SemanticsRole.loadingSpinner,+ child: SizedBox.square(+ dimension: widget.size.diameter,+ child: RotationTransition(+ turns: _turn,+ child: RepaintBoundary(+ child: CustomPaint(+ painter: _LoadingPainter(+ color: widget.color ?? context.componentColors.primary,+ stroke: widget.size.stroke,+ ),+ ),+ ),+ ),+ ),+ );+ }+}++class _LoadingPainter extends CustomPainter {+ _LoadingPainter({required this.color, required this.stroke});++ final Color color;+ final double stroke;++ @override+ void paint(Canvas canvas, Size size) {+ final rect = (Offset.zero & size).deflate(stroke / 2);+ final paint = Paint()+ ..style = PaintingStyle.stroke+ ..strokeWidth = stroke+ ..strokeCap = StrokeCap.round+ ..color = color.withValues(alpha: 0.16);+ canvas.drawOval(rect, paint);+ canvas.drawArc(+ rect,+ -math.pi / 2,+ math.pi / 2,+ false,+ paint..color = color,+ );+ }++ @override+ bool shouldRepaint(_LoadingPainter old) =>+ old.color != color || old.stroke != stroke;+}diff --git a/mobile/packages/ente_components/lib/components/loading/loading_dialog_component.dart b/mobile/packages/ente_components/lib/components/loading/loading_dialog_component.dartnew file mode 100644index 0000000000..d4435686fd--- /dev/null+++ b/mobile/packages/ente_components/lib/components/loading/loading_dialog_component.dart@@ -0,0 +1,127 @@+import 'dart:async';++import 'package:ente_components/components/loading/loading_component.dart';+import 'package:ente_components/theme/motion.dart';+import 'package:ente_components/theme/radii.dart';+import 'package:ente_components/theme/shadows.dart';+import 'package:ente_components/theme/spacing.dart';+import 'package:ente_components/theme/text_styles.dart';+import 'package:ente_components/theme/theme.dart';+import 'package:flutter/material.dart';++LoadingComponentHandle showLoadingComponent(+ BuildContext context,+ String message, {+ bool isDismissible = false,+}) {+ final navigator = Navigator.of(context, rootNavigator: true);+ final themes = InheritedTheme.capture(from: context, to: navigator.context);+ final updates = ValueNotifier(message);+ final route = RawDialogRoute<void>(+ barrierDismissible: isDismissible,+ barrierColor: context.componentColors.specialScrim,+ barrierLabel: MaterialLocalizations.of(context).modalBarrierDismissLabel,+ transitionDuration: Motion.standard,+ transitionBuilder: _loadingTransition,+ traversalEdgeBehavior: TraversalEdgeBehavior.closedLoop,+ pageBuilder: (_, _, _) => themes.wrap(+ PopScope(+ canPop: isDismissible,+ child: SafeArea(child: _LoadingDialog(message: updates)),+ ),+ ),+ );+ unawaited(route.completed.then((_) => updates.dispose()));+ unawaited(navigator.push(route));+ return LoadingComponentHandle._(route, updates);+}++class LoadingComponentHandle {+ LoadingComponentHandle._(this._route, this._message);++ final RawDialogRoute<void> _route;+ final ValueNotifier<String> _message;++ bool isShowing() => _route.isActive;++ void update({String? message}) {+ if (!_route.isActive) return;+ if (message != null) _message.value = message;+ }++ Future<void> hide() {+ final navigator = _route.navigator;+ if (navigator != null && _route.isActive) {+ if (_route.isCurrent) {+ navigator.pop();+ } else {+ navigator.removeRoute(_route);+ }+ }+ return _route.completed;+ }+}++class _LoadingDialog extends StatelessWidget {+ const _LoadingDialog({required this.message});++ final ValueNotifier<String> message;++ @override+ Widget build(BuildContext context) {+ final colors = context.componentColors;+ return Dialog(+ backgroundColor: Colors.transparent,+ elevation: 0,+ insetPadding: const EdgeInsets.symmetric(horizontal: Spacing.xl),+ child: ValueListenableBuilder<String>(+ valueListenable: message,+ builder: (_, message, _) => Container(+ width: 288,+ padding: const EdgeInsets.symmetric(+ horizontal: Spacing.xxl,+ vertical: Spacing.xl,+ ),+ decoration: BoxDecoration(+ color: colors.backgroundBase,+ border: Border.all(color: colors.strokeFaint),+ borderRadius: Radii.buttonBorder,+ boxShadow: Shadows.floating,+ ),+ child: Row(+ children: [+ const LoadingComponent(),+ const SizedBox(width: Spacing.lg),+ Expanded(+ child: Text(+ message,+ style: TextStyles.body.copyWith(color: colors.textBase),+ ),+ ),+ ],+ ),+ ),+ ),+ );+ }+}++Widget _loadingTransition(+ BuildContext context,+ Animation<double> animation,+ Animation<double> secondaryAnimation,+ Widget child,+) {+ return FadeTransition(+ opacity: animation,+ child: ScaleTransition(+ scale: animation.drive(+ Tween<double>(+ begin: 0.96,+ end: 1,+ ).chain(CurveTween(curve: Curves.easeOutCubic)),+ ),+ child: child,+ ),+ );+}diff --git a/mobile/packages/ente_components/lib/ente_components.dart b/mobile/packages/ente_components/lib/ente_components.dartindex cd3af84e81..067b646631 100644--- a/mobile/packages/ente_components/lib/ente_components.dart+++ b/mobile/packages/ente_components/lib/ente_components.dart@@ -11,6 +11,8 @@ export 'components/centered_constrained_component.dart';export 'components/divider_component.dart';export 'components/ente_app_icon.dart';export 'components/filter_chip_component.dart';+export 'components/loading/loading_component.dart';+export 'components/loading/loading_dialog_component.dart';export 'components/menu_component.dart';export 'components/menu_group_component.dart';export 'components/more_from_ente_section.dart';diff --git a/mobile/packages/ente_components/test/components/loading_test.dart b/mobile/packages/ente_components/test/components/loading_test.dartnew file mode 100644index 0000000000..23502ccef9--- /dev/null+++ b/mobile/packages/ente_components/test/components/loading_test.dart@@ -0,0 +1,270 @@+import "dart:ui" show SemanticsRole;++import "package:ente_components/ente_components.dart";+import "package:flutter/material.dart";+import "package:flutter_test/flutter_test.dart";++void main() {+ Widget app(Widget child) => MaterialApp(+ theme: ComponentTheme.lightTheme(),+ home: Scaffold(body: Center(child: child)),+ );+ final paint = find.descendant(+ of: find.byType(LoadingComponent),+ matching: find.byType(CustomPaint),+ );+ const tick = Duration(milliseconds: 1);++ testWidgets("LoadingComponent paints a rotating ring in the three sizes", (+ tester,+ ) async {+ for (final sample in {+ LoadingComponentSize.small: 16.0,+ LoadingComponentSize.medium: 24.0,+ LoadingComponentSize.large: 40.0,+ }.entries) {+ await tester.pumpWidget(app(LoadingComponent(size: sample.key)));+ expect(paint, findsOneWidget);+ expect(+ tester.getSize(find.byType(LoadingComponent)),+ Size.square(sample.value),+ );+ expect(tester.hasRunningAnimations, isTrue);+ }+ });++ testWidgets("showLoadingComponent updates in place and hides", (+ tester,+ ) async {+ await tester.pumpWidget(app(const SizedBox()));+ final handle = showLoadingComponent(+ tester.element(find.byType(Scaffold)),+ "Deleting 3 items",+ );+ await tester.pump();+ await tester.pump(Motion.standard);+ expect(handle.isShowing(), isTrue);+ expect(find.text("Deleting 3 items"), findsOneWidget);++ handle.update(message: "Almost done");+ await tester.pump();+ expect(find.text("Almost done"), findsOneWidget);++ final hidden = handle.hide();+ await tester.pump();+ await tester.pump(Motion.standard);+ await tester.pump(tick);+ await hidden;+ expect(handle.isShowing(), isFalse);+ expect(find.byType(LoadingComponent), findsNothing);+ });++ testWidgets("showLoadingComponent honours isDismissible", (tester) async {+ await tester.pumpWidget(app(const SizedBox()));+ final context = tester.element(find.byType(Scaffold));++ final fixed = showLoadingComponent(context, "Creating link");+ await tester.pump();+ await tester.pump(Motion.standard);+ await tester.pump(tick);+ await tester.binding.handlePopRoute();+ await tester.pump();+ expect(fixed.isShowing(), isTrue);+ await tester.tapAt(const Offset(5, 5));+ await tester.pump();+ await tester.pump(Motion.standard);+ expect(find.text("Creating link"), findsOneWidget);+ final hidden = fixed.hide();+ await tester.pump();+ await tester.pump(Motion.standard);+ await tester.pump(tick);+ await hidden;++ final dismissible = showLoadingComponent(+ context,+ "Creating link",+ isDismissible: true,+ );+ await tester.pump();+ await tester.pump(Motion.standard);+ await tester.tapAt(const Offset(5, 5));+ await tester.pump();+ await tester.pump(Motion.standard);+ await tester.pump(tick);+ expect(find.text("Creating link"), findsNothing);+ expect(dismissible.isShowing(), isFalse);+ dismissible.update(message: "Still safe after dismissal");+ await dismissible.hide();+ });++ testWidgets("LoadingComponent exposes its label and spinner role", (+ tester,+ ) async {+ final handle = tester.ensureSemantics();+ await tester.pumpWidget(+ app(const LoadingComponent(semanticsLabel: "Downloading")),+ );+ expect(+ tester.getSemantics(find.byType(LoadingComponent)),+ isSemantics(label: "Downloading"),+ );+ expect(+ tester+ .getSemantics(find.byType(LoadingComponent))+ .getSemanticsData()+ .role,+ SemanticsRole.loadingSpinner,+ );+ handle.dispose();+ });++ testWidgets("showLoadingComponent uses the caller's theme for every part", (+ tester,+ ) async {+ final local = ComponentTheme.darkTheme(app: ComponentApp.locker);+ final colors = local.extension<ComponentColorTokens>()!.colors;+ await tester.pumpWidget(+ MaterialApp(+ theme: ComponentTheme.lightTheme(),+ home: Theme(+ data: local,+ child: const Scaffold(body: SizedBox()),+ ),+ ),+ );+ showLoadingComponent(tester.element(find.byType(Scaffold)), "Opening");+ await tester.pump();+ await tester.pump(Motion.standard);++ final ring = tester.widget<CustomPaint>(paint);+ expect((ring.painter! as dynamic).color, colors.primary);+ final card = tester.widget<Container>(+ find.ancestor(of: find.text("Opening"), matching: find.byType(Container)),+ );+ expect((card.decoration! as BoxDecoration).color, colors.backgroundBase);+ });++ testWidgets("showLoadingComponent establishes a semantic route", (+ tester,+ ) async {+ final semantics = tester.ensureSemantics();+ await tester.pumpWidget(app(const SizedBox()));+ showLoadingComponent(tester.element(find.byType(Scaffold)), "Opening");+ await tester.pump();+ await tester.pump(Motion.standard);++ var node = tester.getSemantics(find.text("Opening"));+ final spinnerRole = tester+ .getSemantics(find.byType(LoadingComponent))+ .getSemanticsData()+ .role;+ var scopesRoute = false;+ while (true) {+ scopesRoute |= node.getSemanticsData().flagsCollection.scopesRoute;+ final parent = node.parent;+ if (parent == null) break;+ node = parent;+ }+ semantics.dispose();+ expect(scopesRoute, isTrue);+ expect(spinnerRole, SemanticsRole.loadingSpinner);+ });++ testWidgets("showLoadingComponent keeps focus traversal inside the dialog", (+ tester,+ ) async {+ await tester.pumpWidget(+ MaterialApp(+ theme: ComponentTheme.lightTheme(),+ builder: (_, _) => Navigator(+ routeTraversalEdgeBehavior: TraversalEdgeBehavior.leaveFlutterView,+ onGenerateRoute: (_) => MaterialPageRoute<void>(+ builder: (_) => const Scaffold(body: SizedBox()),+ ),+ ),+ ),+ );+ showLoadingComponent(tester.element(find.byType(Scaffold)), "Opening");+ await tester.pump();+ await tester.pump(Motion.standard);+ expect(+ FocusScope.of(tester.element(find.text("Opening"))).traversalEdgeBehavior,+ TraversalEdgeBehavior.closedLoop,+ );+ });++ testWidgets("download progress remains in the message and null keeps it", (+ tester,+ ) async {+ await tester.pumpWidget(app(const SizedBox()));+ final handle = showLoadingComponent(+ tester.element(find.byType(Scaffold)),+ "Downloading",+ );+ await tester.pump();+ await tester.pump(Motion.standard);++ handle.update(message: "Downloading 45%");+ await tester.pump();+ handle.update(message: null);+ await tester.pump();+ expect(find.text("Downloading 45%"), findsOneWidget);+ expect(tester.hasRunningAnimations, isTrue);+ });++ testWidgets(+ "hide before the first frame completes without popping the page",+ (tester) async {+ await tester.pumpWidget(app(const Text("Page")));+ final handle = showLoadingComponent(+ tester.element(find.byType(Scaffold)),+ "Opening",+ );+ final hidden = handle.hide();+ await tester.pumpAndSettle();+ await hidden;+ expect(handle.isShowing(), isFalse);+ expect(find.text("Opening"), findsNothing);+ expect(find.text("Page"), findsOneWidget);+ handle.update(message: "After dismissal");+ await handle.hide();+ },+ );++ testWidgets("hide leaves a newer page on the navigator", (tester) async {+ await tester.pumpWidget(app(const Text("Page")));+ final context = tester.element(find.byType(Scaffold));+ final handle = showLoadingComponent(context, "Opening");+ await tester.pump();+ await tester.pump(Motion.standard);+ Navigator.of(context).push<void>(+ MaterialPageRoute(builder: (_) => const Scaffold(body: Text("New page"))),+ );+ await tester.pumpAndSettle();++ final hidden = handle.hide();+ await tester.pumpAndSettle();+ await hidden;+ expect(handle.isShowing(), isFalse);+ expect(find.text("New page"), findsOneWidget);+ });++ testWidgets("showLoadingComponent centres the card above the keyboard", (+ tester,+ ) async {+ tester.view.physicalSize = const Size(800, 600);+ tester.view.devicePixelRatio = 1;+ tester.view.viewInsets = const FakeViewPadding(bottom: 300);+ addTearDown(tester.view.reset);+ await tester.pumpWidget(app(const SizedBox()));+ showLoadingComponent(tester.element(find.byType(Scaffold)), "Opening");+ await tester.pump();+ await tester.pump(Motion.standard);++ final card = find.ancestor(+ of: find.text("Opening"),+ matching: find.byType(Container),+ );+ expect(tester.getCenter(card).dy, 150);+ });+}