showLedgerSideSheet<T> function

Future<T?> showLedgerSideSheet<T>(
  1. BuildContext context, {
  2. required String title,
  3. required WidgetBuilder builder,
  4. List<Widget> foot(
    1. BuildContext context
    )?,
  5. DesignSheetEdge edge = DesignSheetEdge.end,
  6. double width = 400,
})

Stands a LedgerSideSheet titled title in from edge (the reading end by default) over the whole app, width wide, leaving at least 56 of the screen beside it on a phone; a tap on the scrim, the system back, the Escape key, the close or a drag toward its edge dismisses it, focus coming back to where it was. Completes with the value it pops with.

final applied = await showLedgerSideSheet<bool>(context, title: 'Filters', builder: (context) => filters);

Implementation

Future<T?> showLedgerSideSheet<T>(
  BuildContext context, {
  required String title,
  required WidgetBuilder builder,
  List<Widget> Function(BuildContext context)? foot,
  DesignSheetEdge edge = DesignSheetEdge.end,
  double width = 400,
}) {
  final navigator = LedgerHost.navigatorOf(context);
  final themes = InheritedTheme.capture(from: context, to: navigator.context);
  return navigator.push<T>(
    DesignSideSheetRoute<T>(
      edge: edge,
      width: width,
      semanticLabel: title,
      builder: (sheetContext, sheet) => themes.wrap(
        Builder(
          builder: (context) => LedgerSideSheet(
            title: title,
            side: sheet.side,
            onClose: sheet.close,
            foot: foot?.call(context) ?? const [],
            child: builder(context),
          ),
        ),
      ),
    ),
  );
}