build method

  1. @override
Widget build(
  1. BuildContext context
)
override

Describes the part of the user interface represented by this widget.

The framework calls this method when this widget is inserted into the tree in a given BuildContext and when the dependencies of this widget change (e.g., an InheritedWidget referenced by this widget changes). This method can potentially be called in every frame and should not have any side effects beyond building a widget.

The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing subtree, as determined by calling Widget.canUpdate.

Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and from the given BuildContext.

The given BuildContext contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A given widget might be built with multiple different BuildContext arguments over time if the widget is moved around the tree or if the widget is inserted into the tree in multiple places at once.

The implementation of this method must only depend on:

If a widget's build method is to depend on anything else, use a StatefulWidget instead.

See also:

  • StatelessWidget, which contains the discussion on performance considerations.

Implementation

@override
Widget build(BuildContext context) {
  assert(
    context.findAncestorWidgetOfExactType<Stack>() != null,
    'LoadingOverlay must be a direct child of a Stack. '
    'Wrap it in your own Stack, e.g. '
    'Stack(children: [..., if (isLoading) const LoadingOverlay()]).',
  );
  return Positioned.fill(
    // ENH-37: this Flutter SDK's Semantics widget has no `modal` param
    // (confirmed in framework source — only the lower-level
    // SemanticsConfiguration has one, not exposed here), and this overlay
    // deliberately isn't a real Navigator route either (see class doc —
    // that's the whole reason it exists instead of showDialog), so
    // scopesRoute wouldn't be accurate. liveRegion announces the barrier
    // the moment it appears (same reasoning as ToastBanner/
    // NetworkStatusBanner), and container groups it as 1 node instead of
    // leaking the spinner + message as 2 separate ones.
    child: Semantics(
      label: message ?? 'Loading',
      liveRegion: true,
      container: true,
      excludeSemantics: true,
      child: Container(
        color: Colors.black.withValues(alpha: 0.45),
        alignment: Alignment.center,
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            SizedBox(
              width: 56,
              height: 56,
              child: CircularProgressIndicator(
                strokeWidth: 5,
                valueColor: AlwaysStoppedAnimation(
                  color ?? NeonTheme.magenta,
                ),
                backgroundColor:
                    backgroundColor ??
                    NeonTheme.purple.withValues(alpha: 0.3),
              ),
            ),
            if (message != null) ...[
              const SizedBox(height: NeonTheme.s16),
              Text(
                message!,
                textAlign: TextAlign.center,
                style: const TextStyle(
                  color: Colors.white,
                  fontSize: 15,
                  fontWeight: FontWeight.w700,
                ),
              ),
            ],
          ],
        ),
      ),
    ),
  );
}