showDialog<T> method
Future<T?>
showDialog<T>({
- required WidgetBuilder builder,
- bool barrierDismissible = true,
- double barrierScalar = 0.5,
- Color? barrierColor,
- Color? defaultForeground,
- Color? defaultBackground,
- TerminalColorTheme palette = TerminalColorTheme.legacyVga,
- int width = 40,
- int height = 10,
Displays a modal dialog by adding it as a higher layer.
Returns a Future that completes with the dialog result, or null if
barrierDismissible is true and the user clicks the barrier or presses
unhandled Escape.
Implementation
Future<T?> showDialog<T>({
required WidgetBuilder builder,
bool barrierDismissible = true,
double barrierScalar = 0.5,
Color? barrierColor,
Color? defaultForeground,
Color? defaultBackground,
TerminalColorTheme palette = TerminalColorTheme.legacyVga,
int width = 40,
int height = 10,
}) {
final completer = Completer<T?>();
final runner = PromptRunner<T>(
terminal: terminal,
widget: Builder(builder: builder),
exitConditions: {
...PromptRunner.defaultExitConditions,
if (barrierDismissible) .escape: .cancel,
},
alternateScreen: false,
mode: .managed,
);
final barrierWidget = Stack([
Positioned(
left: 0,
top: 0,
right: 0,
bottom: 0,
child: DimmingBarrier(
scalar: barrierScalar,
barrierColor: barrierColor,
defaultForeground: defaultForeground,
defaultBackground: defaultBackground,
palette: palette,
),
),
if (barrierDismissible)
Positioned(
left: 0,
top: 0,
right: 0,
bottom: 0,
child: ModalDismissBarrier(
onDismiss: runner.abort,
child: const SizedBox.expand(),
),
),
]);
final barrierRunner = PromptRunner<void>(
terminal: terminal,
widget: barrierWidget,
exitConditions: const {},
alternateScreen: false,
mode: .managed,
);
final baseZIndex = 1000 + layers.length * 2;
final barrierLayer = SceneLayer(
renderer: barrierRunner,
sizing: .fullscreen,
zIndex: baseZIndex,
);
_nonFocusableLayers.add(barrierLayer);
final terminalSize = terminal.backend.size;
final x = max(0, (terminalSize.x - width) ~/ 2);
final y = max(0, (terminalSize.y - height) ~/ 2);
late final SceneLayer dialogLayer;
dialogLayer = SceneLayer(
renderer: runner,
sizing: .fixed,
x: x,
y: y,
width: width,
height: height,
zIndex: baseZIndex + 1,
onResize: (newSize) {
dialogLayer.x = max(0, (newSize.x - width) ~/ 2);
dialogLayer.y = max(0, (newSize.y - height) ~/ 2);
},
);
layers.add(barrierLayer);
layers.add(dialogLayer);
focusedLayer = dialogLayer;
barrierRunner.run();
runner
.run()
.then((result) {
completer.complete(result);
})
.catchError((Object err, StackTrace stack) {
if (err is PromptAbortedException) {
completer.complete(null);
} else {
completer.completeError(err, stack);
}
})
.whenComplete(() {
layers.remove(dialogLayer);
layers.remove(barrierLayer);
runner.dispose();
barrierRunner.dispose();
render();
});
render();
return completer.future;
}