Skip to content

Commit

Permalink
add a callback for when the flat tree changes
Browse files Browse the repository at this point in the history
  • Loading branch information
baumths committed May 11, 2024
1 parent 000fcb4 commit 5d71b56
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/src/sliver_animated_tree.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import 'dart:collection' show UnmodifiableListView;

import 'package:flutter/material.dart';

import 'sliver_tree.dart';
Expand Down Expand Up @@ -80,6 +82,7 @@ class SliverAnimatedTree<T extends Object> extends SliverTree<T> {
super.key,
required super.controller,
required super.nodeBuilder,
super.onTreeChanged,
this.transitionBuilder = defaultTreeTransitionBuilder,
this.duration = const Duration(milliseconds: 300),
this.curve = Curves.linear,
Expand Down Expand Up @@ -181,6 +184,7 @@ class _SliverAnimatedTreeState<T extends Object>

_flatTree = flatTree;
_expansionStatesCache = currentExpansionStates;
widget.onTreeChanged?.call(UnmodifiableListView<TreeEntry<T>>(_flatTree));
}

void _rebuild() => setState(_updateFlatTree);
Expand Down
22 changes: 22 additions & 0 deletions lib/src/sliver_tree.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import 'dart:collection' show UnmodifiableListView;

import 'package:flutter/material.dart';

import 'tree_controller.dart';
Expand Down Expand Up @@ -51,6 +53,7 @@ class SliverTree<T extends Object> extends StatefulWidget {
super.key,
required this.controller,
required this.nodeBuilder,
this.onTreeChanged,
});

/// {@template flutter_fancy_tree_view.SliverTree.controller}
Expand All @@ -71,6 +74,24 @@ class SliverTree<T extends Object> extends StatefulWidget {
/// {@endtemplate}
final TreeNodeBuilder<T> nodeBuilder;

/// {@template flutter_fancy_tree_view.SliverTree.onTreeChanged}
/// Called each time the tree gets flattened.
///
/// Whenever the tree changes in any way and a traversal is required (e.g.,
/// when calling [TreeController.rebuild]), this callback is called with the
/// new flat tree.
///
/// This can be useful when an action needs to be executed as soon as the tree
/// gets rebuilt, like highlighting or scrolling to a selected node.
///
/// This callback may get called a lot as the expansion states change.
///
/// Note that for animated tree views, this callback will be called twice
/// for each rebuild, once when the animation begins and one more time when
/// the animation ends.
/// {@endtemplate}
final ValueChanged<List<TreeEntry<T>>>? onTreeChanged;

@override
State<SliverTree<T>> createState() => _SliverTreeState<T>();
}
Expand All @@ -82,6 +103,7 @@ class _SliverTreeState<T extends Object> extends State<SliverTree<T>> {
final List<TreeEntry<T>> flatTree = [];
widget.controller.depthFirstTraversal(onTraverse: flatTree.add);
_flatTree = flatTree;
widget.onTreeChanged?.call(UnmodifiableListView<TreeEntry<T>>(_flatTree));
}

void _rebuild() => setState(_updateFlatTree);
Expand Down
7 changes: 7 additions & 0 deletions lib/src/tree_view.dart
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ class TreeView<T extends Object> extends BoxScrollView {
super.key,
required this.treeController,
required this.nodeBuilder,
this.onTreeChanged,
super.padding,
super.controller,
super.primary,
Expand All @@ -63,11 +64,15 @@ class TreeView<T extends Object> extends BoxScrollView {
/// {@macro flutter_fancy_tree_view.SliverTree.nodeBuilder}
final TreeNodeBuilder<T> nodeBuilder;

/// {@macro flutter_fancy_tree_view.SliverTree.onTreeChanged}
final ValueChanged<List<TreeEntry<T>>>? onTreeChanged;

@override
Widget buildChildLayout(BuildContext context) {
return SliverTree<T>(
controller: treeController,
nodeBuilder: nodeBuilder,
onTreeChanged: onTreeChanged,
);
}
}
Expand Down Expand Up @@ -109,6 +114,7 @@ class AnimatedTreeView<T extends Object> extends TreeView<T> {
super.key,
required super.treeController,
required super.nodeBuilder,
super.onTreeChanged,
this.transitionBuilder = defaultTreeTransitionBuilder,
this.duration = const Duration(milliseconds: 300),
this.curve = Curves.linear,
Expand Down Expand Up @@ -143,6 +149,7 @@ class AnimatedTreeView<T extends Object> extends TreeView<T> {
return SliverAnimatedTree<T>(
controller: treeController,
nodeBuilder: nodeBuilder,
onTreeChanged: onTreeChanged,
transitionBuilder: transitionBuilder,
duration: duration,
curve: curve,
Expand Down

0 comments on commit 5d71b56

Please sign in to comment.