Master detail controller (#358)

* test YaruMasterDetailPage controller * add controller to YaruMasterDetailPage
ubuntu · Nov 3, 2022 · 766e2c3 · 766e2c3
1 parent cfb484c
commit 766e2c3
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 0 deletions.
diff --git a/lib/src/layouts/yaru_landscape_layout.dart b/lib/src/layouts/yaru_landscape_layout.dart
@@ -19,6 +19,7 @@ class YaruLandscapeLayout extends StatefulWidget {
     required this.pageMinWidth,
     this.onLeftPaneWidthChange,
     this.appBar,
+    this.controller,
   });
 
   /// The total number of pages.
@@ -55,6 +56,9 @@ class YaruLandscapeLayout extends StatefulWidget {
   /// If provided, a second [AppBar] will be created right to it.
   final PreferredSizeWidget? appBar;
 
+  /// An optional controller that can be used to navigate to a specific index.
+  final ValueNotifier<int>? controller;
+
   @override
   State<YaruLandscapeLayout> createState() => _YaruLandscapeLayoutState();
 }
@@ -77,6 +81,17 @@ class _YaruLandscapeLayoutState extends State<YaruLandscapeLayout> {
     super.initState();
     _selectedIndex = widget.selectedIndex;
     _leftPaneWidth = widget.leftPaneWidth;
+    widget.controller?.addListener(_controllerCallback);
+  }
+
+  @override
+  void dispose() {
+    widget.controller?.removeListener(_controllerCallback);
+    super.dispose();
+  }
+
+  void _controllerCallback() {
+    _onTap(widget.controller!.value);
   }
 
   void _onTap(int index) {

diff --git a/lib/src/layouts/yaru_master_detail_page.dart b/lib/src/layouts/yaru_master_detail_page.dart
@@ -56,6 +56,7 @@ class YaruMasterDetailPage extends StatefulWidget {
     this.appBar,
     this.initialIndex,
     this.onSelected,
+    this.controller,
   });
 
   /// The total number of pages.
@@ -96,6 +97,9 @@ class YaruMasterDetailPage extends StatefulWidget {
   /// Called when the user selects a page.
   final ValueChanged<int?>? onSelected;
 
+  /// An optional controller that can be used to navigate to a specific index.
+  final ValueNotifier<int>? controller;
+
   @override
   _YaruMasterDetailPageState createState() => _YaruMasterDetailPageState();
 }
@@ -141,6 +145,7 @@ class _YaruMasterDetailPageState extends State<YaruMasterDetailPage> {
             pageBuilder: widget.pageBuilder,
             onSelected: _setIndex,
             appBar: widget.appBar,
+            controller: widget.controller,
           );
         } else {
           return YaruLandscapeLayout(
@@ -155,6 +160,7 @@ class _YaruMasterDetailPageState extends State<YaruMasterDetailPage> {
             pageMinWidth: widget.pageMinWidth,
             onLeftPaneWidthChange: (panWidth) => _leftPaneWidth = panWidth,
             appBar: widget.appBar,
+            controller: widget.controller,
           );
         }
       },

diff --git a/lib/src/layouts/yaru_portrait_layout.dart b/lib/src/layouts/yaru_portrait_layout.dart
@@ -13,6 +13,7 @@ class YaruPortraitLayout extends StatefulWidget {
     required this.pageBuilder,
     required this.onSelected,
     this.appBar,
+    this.controller,
   });
 
   final int length;
@@ -23,6 +24,9 @@ class YaruPortraitLayout extends StatefulWidget {
 
   final PreferredSizeWidget? appBar;
 
+  /// An optional controller that can be used to navigate to a specific index.
+  final ValueNotifier<int>? controller;
+
   @override
   _YaruPortraitLayoutState createState() => _YaruPortraitLayoutState();
 }
@@ -36,9 +40,21 @@ class _YaruPortraitLayoutState extends State<YaruPortraitLayout> {
   @override
   void initState() {
     _selectedIndex = widget.selectedIndex;
+    widget.controller?.addListener(_controllerCallback);
     super.initState();
   }
 
+  @override
+  void dispose() {
+    widget.controller?.removeListener(_controllerCallback);
+    super.dispose();
+  }
+
+  void _controllerCallback() {
+    _navigator.popUntil((route) => route.isFirst);
+    _onTap(widget.controller!.value);
+  }
+
   void _onTap(int index) {
     widget.onSelected(index);
     _navigator.push(pageRoute(index));

diff --git a/test/pages/yaru_master_detail_page_test.dart b/test/pages/yaru_master_detail_page_test.dart
@@ -42,6 +42,47 @@ void main() {
     variant: goldenVariant,
     tags: 'golden',
   );
+
+  testWidgets(
+    'controller',
+    (tester) async {
+      final variant = goldenVariant.currentValue!;
+      final controller = ValueNotifier<int>(0);
+      await tester.pumpScaffold(
+        YaruMasterDetailPage(
+          controller: controller,
+          leftPaneWidth: kYaruMasterDetailBreakpoint / 3,
+          length: 8,
+          appBar: AppBar(title: const Text('Master')),
+          tileBuilder: (context, index, selected) => YaruMasterTile(
+            leading: const Icon(YaruIcons.menu),
+            title: Text('Tile $index'),
+          ),
+          pageBuilder: (context, index) => YaruDetailPage(
+            appBar: AppBar(
+              title: Text('Detail title $index'),
+            ),
+            body: Center(child: Text('Detail body $index')),
+          ),
+        ),
+        themeMode: variant.themeMode,
+        size: Size(variant.value!, 480),
+      );
+
+      controller.value = 3;
+      await tester.pumpAndSettle();
+      if (variant.label.startsWith('portrait')) {
+        expect(find.text('Master'), findsNothing);
+        expect(find.text('Tile 3'), findsNothing);
+      } else if (variant.label.startsWith('landscape')) {
+        expect(find.text('Master'), findsOneWidget);
+        expect(find.text('Tile 3'), findsOneWidget);
+      }
+      expect(find.text('Detail title 3'), findsOneWidget);
+      expect(find.text('Detail body 3'), findsOneWidget);
+    },
+    variant: goldenVariant,
+  );
 }
 
 final goldenVariant = ValueVariant({