platformBrightness property

  1. @Deprecated('Use WidgetTester.platformDispatcher.platformBrightness instead. ' 'Deprecated to prepare for the upcoming multi-window support. ' 'This feature was deprecated after v3.9.0-0.1.pre.')
  2. @override
Brightness get platformBrightness
override

The setting indicating the current brightness mode of the host platform.

Accessing this value returns the value contained in the PlatformDispatcher singleton, so instead of getting it from here, you should consider getting it from WidgetsBinding.instance.platformDispatcher instead (or, when WidgetsBinding isn't available, from PlatformDispatcher.instance). The reason this value forwards to the PlatformDispatcher is to provide convenience for applications that only use a single main window.

If the platform has no preference, platformBrightness defaults to Brightness.light.

Implementation

@Deprecated(
  'Use WidgetTester.platformDispatcher.platformBrightness instead. '
  'Deprecated to prepare for the upcoming multi-window support. '
  'This feature was deprecated after v3.9.0-0.1.pre.'
)
@override
Brightness get platformBrightness => platformDispatcher.platformBrightness;