Commit 1146587c authored by Adam Barth's avatar Adam Barth Committed by GitHub

Improve Scaffold.of docs (#7339)

The docs now include all the information contained in the exception.

Fixes #6994
parent 86e5fce6
...@@ -465,6 +465,16 @@ class Scaffold extends StatefulWidget { ...@@ -465,6 +465,16 @@ class Scaffold extends StatefulWidget {
/// } /// }
/// ``` /// ```
/// ///
/// A more efficient solution is to split your build function into several
/// widgets. This introduces a new context from which you can obtain the
/// [Scaffold]. In this solution, you would have an outer widget that creates
/// the [Scaffold] populated by instances of your new inner widgets, and then
/// in these inner widgets you would use [Scaffold.of].
///
/// A less elegant but more expedient solution is assign a [GlobalKey] to the
/// [Scaffold], then use the `key.currentState` property to obtain the
/// [ScaffoldState] rather than using the [Scaffold.of] function.
///
/// If there is no [Scaffold] in scope, then this will throw an exception. /// If there is no [Scaffold] in scope, then this will throw an exception.
/// To return null if there is no [Scaffold], then pass `nullOk: true`. /// To return null if there is no [Scaffold], then pass `nullOk: true`.
static ScaffoldState of(BuildContext context, { bool nullOk: false }) { static ScaffoldState of(BuildContext context, { bool nullOk: false }) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment