Skip to content

Commit 8bb6d75

Browse files
authored
[Widget Preview] Isolate PageStorage scope in widget preview group expansion tile (flutter#191378)
## Description When a preview group is collapsed and re-expanded in the Widget Previewer, descendant scrollables (which search ancestor elements for a `PageStorageKey` when restoring scroll offset) inherit the `PageStorageKey` from the `ExpansionTile`. They then attempt to read the `ExpansionTile`'s boolean expansion state as a double, throwing a `TypeError: true: type 'bool' is not a subtype of type 'double?'`. This PR wraps the `ExpansionTile` children in a `PageStorage` widget with a new `PageStorageBucket`, preventing descendant scrollable widgets from inheriting the `ExpansionTile`'s `PageStorageKey`. ## Related Issues Fixes flutter#191242 ## Tests - Tested in widget preview scaffold template.
1 parent e210443 commit 8bb6d75

2 files changed

Lines changed: 74 additions & 32 deletions

File tree

‎dev/integration_tests/widget_preview_scaffold/lib/src/widget_preview_rendering.dart‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ class PreviewWidgetElement extends StatelessElement {
217217
PreviewWidgetElement(super.widget);
218218
}
219219

220-
class WidgetPreviewGroupWidget extends StatelessWidget {
220+
class WidgetPreviewGroupWidget extends StatefulWidget {
221221
const WidgetPreviewGroupWidget({
222222
super.key,
223223
required this.controller,
@@ -235,14 +235,22 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
235235
// TODO(bkonyi): inherit this from the theme.
236236
static const _kCardRadius = Radius.circular(12);
237237

238+
@override
239+
State<WidgetPreviewGroupWidget> createState() =>
240+
_WidgetPreviewGroupWidgetState();
241+
}
242+
243+
class _WidgetPreviewGroupWidgetState extends State<WidgetPreviewGroupWidget> {
244+
final _bucket = PageStorageBucket();
245+
238246
Widget _buildGridViewFlex(List<WidgetPreview> previews) {
239247
return Wrap(
240248
spacing: WidgetPreviewGroupWidget._gridSpacing,
241249
runSpacing: WidgetPreviewGroupWidget._gridRunSpacing,
242250
alignment: WrapAlignment.start,
243251
children: [
244252
for (final WidgetPreview preview in previews)
245-
WidgetPreviewWidget(controller: controller, preview: preview),
253+
WidgetPreviewWidget(controller: widget.controller, preview: preview),
246254
],
247255
);
248256
}
@@ -253,7 +261,7 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
253261
for (final preview in previews)
254262
Center(
255263
child: WidgetPreviewWidget(
256-
controller: controller,
264+
controller: widget.controller,
257265
preview: preview,
258266
),
259267
),
@@ -269,28 +277,41 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
269277
data: ListTileTheme.of(context).copyWith(
270278
dense: true,
271279
shape: RoundedRectangleBorder(
272-
borderRadius: BorderRadius.all(_kCardRadius),
280+
borderRadius: BorderRadius.all(
281+
WidgetPreviewGroupWidget._kCardRadius,
282+
),
273283
),
274284
),
275285
child: Theme(
276286
// Prevents divider lines appearing at the top and bottom of the
277287
// expanded ExpansionTile.
278288
data: theme.copyWith(dividerColor: Colors.transparent),
279289
child: ExpansionTile(
280-
key: PageStorageKey(group.name),
281-
title: Text(group.name),
290+
key: PageStorageKey(widget.group.name),
291+
title: Text(widget.group.name),
282292
initiallyExpanded: true,
283293
children: [
284-
ValueListenableBuilder<LayoutType>(
285-
valueListenable: controller.layoutTypeListenable,
286-
builder: (context, selectedLayout, _) {
287-
return switch (selectedLayout) {
288-
LayoutType.gridView => _buildGridViewFlex(group.previews),
289-
LayoutType.listView => _buildVerticalListView(
290-
group.previews,
291-
),
292-
};
293-
},
294+
// Wrap children in a PageStorage to create a storage boundary.
295+
// Without this, descendant scrollables (which search ancestor
296+
// elements for a PageStorageKey when restoring scroll offset)
297+
// inherit the PageStorageKey from the ExpansionTile and attempt
298+
// to read the ExpansionTile's boolean expansion state as a double,
299+
// throwing a TypeError (see https://github.com/flutter/flutter/issues/191242).
300+
PageStorage(
301+
bucket: _bucket,
302+
child: ValueListenableBuilder<LayoutType>(
303+
valueListenable: widget.controller.layoutTypeListenable,
304+
builder: (context, selectedLayout, _) {
305+
return switch (selectedLayout) {
306+
LayoutType.gridView => _buildGridViewFlex(
307+
widget.group.previews,
308+
),
309+
LayoutType.listView => _buildVerticalListView(
310+
widget.group.previews,
311+
),
312+
};
313+
},
314+
),
294315
),
295316
],
296317
),

‎packages/flutter_tools/templates/widget_preview_scaffold/lib/src/widget_preview_rendering.dart.tmpl‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ class PreviewWidgetElement extends StatelessElement {
217217
PreviewWidgetElement(super.widget);
218218
}
219219

220-
class WidgetPreviewGroupWidget extends StatelessWidget {
220+
class WidgetPreviewGroupWidget extends StatefulWidget {
221221
const WidgetPreviewGroupWidget({
222222
super.key,
223223
required this.controller,
@@ -235,14 +235,22 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
235235
// TODO(bkonyi): inherit this from the theme.
236236
static const _kCardRadius = Radius.circular(12);
237237

238+
@override
239+
State<WidgetPreviewGroupWidget> createState() =>
240+
_WidgetPreviewGroupWidgetState();
241+
}
242+
243+
class _WidgetPreviewGroupWidgetState extends State<WidgetPreviewGroupWidget> {
244+
final _bucket = PageStorageBucket();
245+
238246
Widget _buildGridViewFlex(List<WidgetPreview> previews) {
239247
return Wrap(
240248
spacing: WidgetPreviewGroupWidget._gridSpacing,
241249
runSpacing: WidgetPreviewGroupWidget._gridRunSpacing,
242250
alignment: WrapAlignment.start,
243251
children: [
244252
for (final WidgetPreview preview in previews)
245-
WidgetPreviewWidget(controller: controller, preview: preview),
253+
WidgetPreviewWidget(controller: widget.controller, preview: preview),
246254
],
247255
);
248256
}
@@ -253,7 +261,7 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
253261
for (final preview in previews)
254262
Center(
255263
child: WidgetPreviewWidget(
256-
controller: controller,
264+
controller: widget.controller,
257265
preview: preview,
258266
),
259267
),
@@ -269,28 +277,41 @@ class WidgetPreviewGroupWidget extends StatelessWidget {
269277
data: ListTileTheme.of(context).copyWith(
270278
dense: true,
271279
shape: RoundedRectangleBorder(
272-
borderRadius: BorderRadius.all(_kCardRadius),
280+
borderRadius: BorderRadius.all(
281+
WidgetPreviewGroupWidget._kCardRadius,
282+
),
273283
),
274284
),
275285
child: Theme(
276286
// Prevents divider lines appearing at the top and bottom of the
277287
// expanded ExpansionTile.
278288
data: theme.copyWith(dividerColor: Colors.transparent),
279289
child: ExpansionTile(
280-
key: PageStorageKey(group.name),
281-
title: Text(group.name),
290+
key: PageStorageKey(widget.group.name),
291+
title: Text(widget.group.name),
282292
initiallyExpanded: true,
283293
children: [
284-
ValueListenableBuilder<LayoutType>(
285-
valueListenable: controller.layoutTypeListenable,
286-
builder: (context, selectedLayout, _) {
287-
return switch (selectedLayout) {
288-
LayoutType.gridView => _buildGridViewFlex(group.previews),
289-
LayoutType.listView => _buildVerticalListView(
290-
group.previews,
291-
),
292-
};
293-
},
294+
// Wrap children in a PageStorage to create a storage boundary.
295+
// Without this, descendant scrollables (which search ancestor
296+
// elements for a PageStorageKey when restoring scroll offset)
297+
// inherit the PageStorageKey from the ExpansionTile and attempt
298+
// to read the ExpansionTile's boolean expansion state as a double,
299+
// throwing a TypeError (see https://github.com/flutter/flutter/issues/191242).
300+
PageStorage(
301+
bucket: _bucket,
302+
child: ValueListenableBuilder<LayoutType>(
303+
valueListenable: widget.controller.layoutTypeListenable,
304+
builder: (context, selectedLayout, _) {
305+
return switch (selectedLayout) {
306+
LayoutType.gridView => _buildGridViewFlex(
307+
widget.group.previews,
308+
),
309+
LayoutType.listView => _buildVerticalListView(
310+
widget.group.previews,
311+
),
312+
};
313+
},
314+
),
294315
),
295316
],
296317
),

0 commit comments

Comments
 (0)