showDesignCommandPalette function

Future<void> showDesignCommandPalette({
  1. required BuildContext context,
  2. required DesignCommandPalette palette(
    1. ValueChanged<DesignCommand> run
    ),
  3. Widget surfaceBuilder(
    1. BuildContext context,
    2. Widget palette
    )?,
  4. Color barrierColor = const Color(0x66000000),
  5. DesignBarrierBuilder? barrierBuilder,
  6. String? barrierLabel,
  7. AlignmentGeometry alignment = const Alignment(0, -0.6),
})

Opens palette in a modal route over a barrier; surfaceBuilder paints the panel around it. A command runs after the route has closed and focus is back where it was.

The barrier is barrierColor, or barrierBuilder's painting (a look's own screen, as its other modals wear) when given.

Implementation

Future<void> showDesignCommandPalette({
  required BuildContext context,
  required DesignCommandPalette Function(ValueChanged<DesignCommand> run)
  palette,
  Widget Function(BuildContext context, Widget palette)? surfaceBuilder,
  Color barrierColor = const Color(0x66000000),
  DesignBarrierBuilder? barrierBuilder,
  String? barrierLabel,
  AlignmentGeometry alignment = const Alignment(0, -0.6),
}) async {
  final chosen = await Navigator.of(context, rootNavigator: true).push(
    _PaletteRoute<DesignCommand>(
      barrierPaint: barrierBuilder,
      barrierDismissible: true,
      barrierLabel:
          barrierLabel ??
          DesignLocalizations.of(context).commandPaletteBarrierLabel,
      barrierColor: barrierBuilder == null ? barrierColor : null,
      transitionDuration: designReduceMotionOf(context)
          ? Duration.zero
          : const Duration(milliseconds: 150),
      transitionBuilder: (context, animation, _, child) =>
          FadeTransition(opacity: animation, child: child),
      pageBuilder: (context, _, _) {
        final body = palette((c) => Navigator.of(context).pop(c));
        return SafeArea(
          child: Align(
            alignment: alignment,
            child: Semantics(
              scopesRoute: true,
              namesRoute: true,
              explicitChildNodes: true,
              label:
                  body.semanticLabel ??
                  DesignLocalizations.of(context).commandPaletteLabel,
              child: surfaceBuilder?.call(context, body) ?? body,
            ),
          ),
        );
      },
    ),
  );
  chosen?.onPressed?.call();
}