firka/flutter
firka/flutter
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for best practices for StreamBuilder like FutureBuilder (#143295)

Browse Source 
Fixes https://github.com/flutter/flutter/issues/142189
This commit is contained in:
Valentin Vignal 2024-02-13 02:25:57 +08:00 committed by GitHub
parent cf2c68417f
commit 52f923c360
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/flutter/lib/src/widgets/async.dart
View File

@ -321,6 +321,20 @@ typedef AsyncWidgetBuilder<T> = Widget Function(BuildContext context, AsyncSnaps
/// ///
/// {@youtube 560 315 https://www.youtube.com/watch?v=MkKEWHfy99Y} /// {@youtube 560 315 https://www.youtube.com/watch?v=MkKEWHfy99Y}
/// ///
/// ## Managing the stream
///
/// The [stream] must have been obtained earlier, e.g. during [State.initState],
/// [State.didUpdateWidget], or [State.didChangeDependencies]. It must not be
/// created during the [State.build] or [StatelessWidget.build] method call when
/// constructing the [StreamBuilder]. If the [stream] is created at the same
/// time as the [StreamBuilder], then every time the [StreamBuilder]'s parent is
/// rebuilt, the asynchronous task will be restarted.
///
/// A general guideline is to assume that every `build` method could get called
/// every frame, and to treat omitted calls as an optimization.
///
/// ## Timing
///
/// Widget rebuilding is scheduled by each interaction, using [State.setState], /// Widget rebuilding is scheduled by each interaction, using [State.setState],
/// but is otherwise decoupled from the timing of the stream. The [builder] /// but is otherwise decoupled from the timing of the stream. The [builder]
/// is called at the discretion of the Flutter pipeline, and will thus receive a /// is called at the discretion of the Flutter pipeline, and will thus receive a