runWidgetApp function

Future<void> runWidgetApp(
  1. WidgetApp app, {
  2. ProgramOptions? options,
  3. ProgramHost? host,
  4. ImageAutoMode? imageAutoMode,
})

Runs a WidgetApp with widget-oriented runtime defaults.

Pass options to override the defaults, or host to target a custom terminal/backend such as a bridge, websocket, or embedded terminal.

The default options enable runtime.MouseMode.allMotion, which is needed for passive hover behaviors such as tooltips, hover styling, and MouseRegion enter/exit callbacks. They also disable startup probes so interactive widget UIs do not defer early hover-driven repaints behind terminal capability probing; opt back in with options if you need the lower-level runtime startup probes.

Implementation

Future<void> runWidgetApp(
  WidgetApp app, {
  runtime.ProgramOptions? options,
  hosts.ProgramHost? host,
  ImageAutoMode? imageAutoMode,
}) {
  return runtime.runProgram(
    _configureImageAutoMode(app, imageAutoMode: imageAutoMode),
    options: options ?? defaultWidgetProgramOptions,
    host: host,
  );
}