Update ExpansibleController in ExpansionTile didUpdateWidget (#173175)

Fixes https://github.com/flutter/flutter/issues/138916

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
This commit is contained in:
Valentin Vignal 2025-08-11 23:27:56 +08:00 committed by GitHub
parent dd2d7b5e3a
commit 705c3d6b71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 234 additions and 4 deletions

View File

@ -94,7 +94,7 @@ typedef ExpansionTileController = ExpansibleController;
/// {@end-tool}
///
/// {@tool dartpad}
/// This example demonstrates how an [ExpansionTileController] can be used to
/// This example demonstrates how an [ExpansibleController] can be used to
/// programmatically expand or collapse an [ExpansionTile].
///
/// ** See code in examples/api/lib/material/expansion_tile/expansion_tile.1.dart **
@ -398,7 +398,7 @@ class ExpansionTile extends StatefulWidget {
/// In cases where control over the tile's state is needed from a callback
/// triggered by a widget within the tile, [ExpansibleController.of] may be
/// more convenient than supplying a controller.
final ExpansionTileController? controller;
final ExpansibleController? controller;
/// {@macro flutter.material.ListTile.dense}
final bool? dense;
@ -497,7 +497,7 @@ class _ExpansionTileState extends State<ExpansionTile> {
late Animation<Color?> _backgroundColor;
late ExpansionTileThemeData _expansionTileTheme;
late ExpansionTileController _tileController;
late ExpansibleController _tileController;
Timer? _timer;
late Curve _curve;
late Curve? _reverseCurve;
@ -508,7 +508,7 @@ class _ExpansionTileState extends State<ExpansionTile> {
super.initState();
_curve = Curves.easeIn;
_duration = _kExpand;
_tileController = widget.controller ?? ExpansionTileController();
_tileController = widget.controller ?? ExpansibleController();
if (widget.initiallyExpanded) {
_tileController.expand();
}
@ -718,6 +718,15 @@ class _ExpansionTileState extends State<ExpansionTile> {
_updateAnimationDuration();
_updateHeightFactorCurve();
}
if (widget.controller != oldWidget.controller) {
_tileController.removeListener(_onExpansionChanged);
if (oldWidget.controller == null) {
_tileController.dispose();
}
_tileController = widget.controller ?? ExpansibleController();
_tileController.addListener(_onExpansionChanged);
}
}
@override

View File

@ -329,6 +329,9 @@ class _ExpansibleState extends State<Expansible> with SingleTickerProviderStateM
if (widget.controller != oldWidget.controller) {
oldWidget.controller.removeListener(_toggleExpansion);
widget.controller.addListener(_toggleExpansion);
if (oldWidget.controller.isExpanded != widget.controller.isExpanded) {
_toggleExpansion();
}
}
}

View File

@ -1744,4 +1744,106 @@ void main() {
final Offset offsetPlatform = tester.getTopLeft(platform);
expect(offsetPlatform, const Offset(16.0, 17.0));
});
testWidgets('ExpansionTile can accept a new controller', (WidgetTester tester) async {
final ExpansibleController controller1 = ExpansibleController();
final ExpansibleController controller2 = ExpansibleController();
addTearDown(() {
controller1.dispose();
controller2.dispose();
});
await tester.pumpWidget(
MaterialApp(
home: Material(
child: ExpansionTile(
controller: controller1,
title: const Text('Title'),
initiallyExpanded: true,
children: const <Widget>[Text('Child 0')],
),
),
),
);
expect(find.text('Child 0'), findsOne);
expect(controller1.isExpanded, isTrue);
controller1.collapse();
expect(controller1.isExpanded, isFalse);
await tester.pumpAndSettle();
expect(find.text('Child 0'), findsNothing);
await tester.pumpWidget(
MaterialApp(
home: Material(
child: ExpansionTile(
controller: controller2,
title: const Text('Title'),
initiallyExpanded: true,
children: const <Widget>[Text('Child 0')],
),
),
),
);
expect(find.text('Child 0'), findsNothing);
controller2.expand();
expect(controller2.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Child 0'), findsOne);
});
testWidgets('ExpansionTile can accept a new controller with a different state', (
WidgetTester tester,
) async {
final ExpansibleController controller1 = ExpansibleController();
final ExpansibleController controller2 = ExpansibleController();
addTearDown(() {
controller1.dispose();
controller2.dispose();
});
await tester.pumpWidget(
MaterialApp(
home: Material(
child: ExpansionTile(
controller: controller1,
title: const Text('Title'),
children: const <Widget>[Text('Child 0')],
),
),
),
);
expect(find.text('Child 0'), findsNothing);
expect(controller1.isExpanded, isFalse);
controller1.expand();
expect(controller1.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Child 0'), findsOne);
await tester.pumpWidget(
MaterialApp(
home: Material(
child: ExpansionTile(
controller: controller2,
title: const Text('Title'),
children: const <Widget>[Text('Child 0')],
),
),
),
);
await tester.pumpAndSettle();
expect(
find.text('Child 0'),
findsNothing,
reason: 'The widget should update to the state of the new controller',
);
controller2.expand();
expect(controller2.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Child 0'), findsOne);
});
}

View File

@ -247,4 +247,120 @@ void main() {
controller.dispose();
});
testWidgets('ExpansionTile can accept a new controller', (WidgetTester tester) async {
final ExpansibleController controller1 = ExpansibleController();
final ExpansibleController controller2 = ExpansibleController();
addTearDown(() {
controller1.dispose();
controller2.dispose();
});
await tester.pumpWidget(
MaterialApp(
home: Material(
child: Expansible(
controller: controller1,
headerBuilder: (_, _) => const Text('Header'),
bodyBuilder: (_, _) => const Text('Body'),
),
),
),
);
expect(find.text('Body'), findsNothing);
expect(controller1.isExpanded, isFalse);
controller1.expand();
expect(controller1.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Body'), findsOne);
controller1.collapse();
expect(controller1.isExpanded, isFalse);
await tester.pumpAndSettle();
expect(find.text('Body'), findsNothing);
await tester.pumpWidget(
MaterialApp(
home: Material(
child: Expansible(
controller: controller2,
headerBuilder: (_, _) => const Text('Header'),
bodyBuilder: (_, _) => const Text('Body'),
),
),
),
);
expect(find.text('Body'), findsNothing);
expect(controller2.isExpanded, isFalse);
controller2.expand();
expect(controller2.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Body'), findsOne);
controller2.collapse();
expect(controller2.isExpanded, isFalse);
await tester.pumpAndSettle();
expect(find.text('Body'), findsNothing);
});
testWidgets('Expansible can accept a new controller with a different state', (
WidgetTester tester,
) async {
final ExpansibleController controller1 = ExpansibleController();
final ExpansibleController controller2 = ExpansibleController();
addTearDown(() {
controller1.dispose();
controller2.dispose();
});
await tester.pumpWidget(
MaterialApp(
home: Material(
child: Expansible(
controller: controller1,
headerBuilder: (_, _) => const Text('Header'),
bodyBuilder: (_, _) => const Text('Body'),
),
),
),
);
expect(find.text('Body'), findsNothing);
expect(controller1.isExpanded, isFalse);
controller1.expand();
expect(controller1.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Body'), findsOne);
await tester.pumpWidget(
MaterialApp(
home: Material(
child: Expansible(
controller: controller2,
headerBuilder: (_, _) => const Text('Header'),
bodyBuilder: (_, _) => const Text('Body'),
),
),
),
);
await tester.pumpAndSettle();
expect(controller2.isExpanded, isFalse);
expect(find.text('Body'), findsNothing);
controller2.expand();
expect(controller2.isExpanded, isTrue);
await tester.pumpAndSettle();
expect(find.text('Body'), findsOne);
controller2.collapse();
expect(controller2.isExpanded, isFalse);
await tester.pumpAndSettle();
expect(find.text('Body'), findsNothing);
});
}