flutter/examples/api/lib/widgets/keep_alive/keep_alive.0.dart
Valentin Vignal c6ceffa2e7
Add documentation examples to KeepAlive AutomaticKeepAlive and AutomaticKeepAliveClientMixin (#168137)
Part of https://github.com/flutter/flutter/issues/153860



https://github.com/user-attachments/assets/8fd233da-d1b1-417a-8854-8d16c3ad195b



https://github.com/user-attachments/assets/93197949-b962-483e-bb8f-02db5206674c



https://github.com/user-attachments/assets/ad4f4091-6ed3-4a13-bcf3-f8572ce87481



## 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].

<!-- 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
2025-05-02 07:03:35 +00:00

65 lines
1.7 KiB
Dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:flutter/material.dart';
/// Flutter code sample for [KeepAlive].
///
/// This example demonstrates how to use the [KeepAlive] to preserve the state
/// of individual list items in a `ListView` when they are scrolled out of view.
/// Each item has a counter that maintains its state.
void main() {
runApp(const KeepAliveExampleApp());
}
class KeepAliveExampleApp extends StatelessWidget {
const KeepAliveExampleApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(title: const Text('KeepAlive Example')),
body: ListView.builder(
addAutomaticKeepAlives: false,
addRepaintBoundaries: false,
addSemanticIndexes: false,
itemCount: 100,
itemBuilder: (BuildContext context, int index) {
return KeepAlive(keepAlive: index.isEven, child: _KeepAliveItem(index: index));
},
),
),
);
}
}
class _KeepAliveItem extends StatefulWidget {
const _KeepAliveItem({required this.index});
final int index;
@override
State<_KeepAliveItem> createState() => _KeepAliveItemState();
}
class _KeepAliveItemState extends State<_KeepAliveItem> {
int _counter = 0;
@override
Widget build(BuildContext context) {
return ListTile(
title: Text('Item ${widget.index}: $_counter'),
trailing: IconButton(
icon: const Icon(Icons.add),
onPressed: () {
setState(() {
_counter++;
});
},
),
);
}
}