DocumentFutureBuilder<T> class
A widget that builds UI based on a future of document data.
This widget is suitable for fetching document content from the CMS once, and then rendering it in the app. If the app needs to fetch content multiple times, use DocumentStreamBuilder instead.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DocumentFutureBuilder
Constructors
-
DocumentFutureBuilder({Key? key, required Future<
T?> future(), required Widget buildContent(BuildContext context, T document), bool allowRefresh = true, bool isRoute = false, Uri? location, Object? requestKey}) -
Creates a DocumentFutureBuilder.
const
Properties
- allowRefresh → bool
-
Whether to allow refreshing the document, with the overlay Refresh button.
final
- buildContent → Widget Function(BuildContext context, T document)
-
A function that builds the UI for the content.
final
-
future
→ Future<
T?> Function() -
The future that resolves with the document data.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isRoute → bool
-
Whether this document is a whole route. A route that fails shows a
full page with Back and Go home; other content fails inline.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- location → Uri?
-
The location being shown, included in failure reports.
final
- requestKey → Object?
-
Identifies the document being fetched. When set, the builder refetches
only when this value changes, so a parent passing a new future
closure on every build doesn't trigger a refetch. When null, a new
future function does.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< DocumentFutureBuilder< T> > -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited