PiPMaterialApp class
Constructors
PiPMaterialApp ({Key ? key , GlobalKey <NavigatorState > ? navigatorKey , GlobalKey <ScaffoldMessengerState > ? scaffoldMessengerKey , Widget ? home , Map <String , WidgetBuilder > routes = const <String, WidgetBuilder>{} , String ? initialRoute , RouteFactory ? onGenerateRoute , InitialRouteListFactory ? onGenerateInitialRoutes , RouteFactory ? onUnknownRoute , List <NavigatorObserver > navigatorObservers = const <NavigatorObserver>[] , TransitionBuilder ? builder , String title = '' , GenerateAppTitle ? onGenerateTitle , Color ? color , ThemeData ? theme , ThemeData ? darkTheme , ThemeData ? highContrastTheme , ThemeData ? highContrastDarkTheme , ThemeMode ? themeMode = ThemeMode.system , Duration themeAnimationDuration = kThemeAnimationDuration , Curve themeAnimationCurve = Curves.linear , Locale ? locale , Iterable <LocalizationsDelegate > ? localizationsDelegates , LocaleListResolutionCallback ? localeListResolutionCallback , LocaleResolutionCallback ? localeResolutionCallback , Iterable <Locale > supportedLocales = const <Locale>[Locale('en', 'US')] , bool debugShowMaterialGrid = false , bool showPerformanceOverlay = false , bool checkerboardRasterCacheImages = false , bool checkerboardOffscreenLayers = false , bool showSemanticsDebugger = false , bool debugShowCheckedModeBanner = true , Map <ShortcutActivator , Intent > ? shortcuts , Map <Type , Action <Intent > > ? actions , String ? restorationScopeId , ScrollBehavior ? scrollBehavior , @Deprecated ('Remove this parameter as it is now ignored. ' 'MaterialApp never introduces its own MediaQuery; the View widget takes care of that. ' 'This feature was deprecated after v3.7.0-29.0.pre.') bool useInheritedMediaQuery = false , NotificationListenerCallback <NavigationNotification > ? onNavigationNotification , AnimationStyle ? themeAnimationStyle , PiPParams pipParams = const PiPParams() })
PiPMaterialApp.router ({Key ? key , GlobalKey <ScaffoldMessengerState > ? scaffoldMessengerKey , RouteInformationProvider ? routeInformationProvider , RouteInformationParser <Object > ? routeInformationParser , RouterDelegate <Object > ? routerDelegate , RouterConfig <Object > ? routerConfig , BackButtonDispatcher ? backButtonDispatcher , TransitionBuilder ? builder , String title = '' , GenerateAppTitle ? onGenerateTitle , Color ? color , ThemeData ? theme , ThemeData ? darkTheme , ThemeData ? highContrastTheme , ThemeData ? highContrastDarkTheme , ThemeMode ? themeMode = ThemeMode.system , Duration themeAnimationDuration = kThemeAnimationDuration , Curve themeAnimationCurve = Curves.linear , Locale ? locale , Iterable <LocalizationsDelegate > ? localizationsDelegates , LocaleListResolutionCallback ? localeListResolutionCallback , LocaleResolutionCallback ? localeResolutionCallback , Iterable <Locale > supportedLocales = const <Locale>[Locale('en', 'US')] , bool debugShowMaterialGrid = false , bool showPerformanceOverlay = false , bool checkerboardRasterCacheImages = false , bool checkerboardOffscreenLayers = false , bool showSemanticsDebugger = false , bool debugShowCheckedModeBanner = true , Map <ShortcutActivator , Intent > ? shortcuts , Map <Type , Action <Intent > > ? actions , String ? restorationScopeId , ScrollBehavior ? scrollBehavior , @Deprecated ('Remove this parameter as it is now ignored. ' 'MaterialApp never introduces its own MediaQuery; the View widget takes care of that. ' 'This feature was deprecated after v3.7.0-29.0.pre.') bool useInheritedMediaQuery = false , NotificationListenerCallback <NavigationNotification > ? onNavigationNotification , AnimationStyle ? themeAnimationStyle , PiPParams pipParams = const PiPParams() })
Properties
actions
→ Map <Type , Action <Intent > > ?
The default map of intent keys to actions for the application.
final
backButtonDispatcher
→ BackButtonDispatcher ?
A delegate that decide whether to handle the Android back button intent.
final
builder
→ TransitionBuilder ?
A builder for inserting widgets above the Navigator or - when the
WidgetsApp.router constructor is used - above the Router but below the
other widgets created by the WidgetsApp widget, or for replacing the
Navigator /Router entirely.
final
checkerboardOffscreenLayers
→ bool
Turns on checkerboarding of layers rendered to offscreen bitmaps.
final
checkerboardRasterCacheImages
→ bool
Turns on checkerboarding of raster cache images.
final
color
→ Color ?
The primary color to use for the application in the operating system
interface.
final
darkTheme
→ ThemeData ?
The ThemeData to use when a 'dark mode' is requested by the system.
final
debugShowCheckedModeBanner
→ bool
Turns on a little "DEBUG" banner in debug mode to indicate
that the app is in debug mode. This is on by default (in
debug mode), to turn it off, set the constructor argument to
false. In release mode this has no effect.
final
debugShowMaterialGrid
→ bool
Turns on a GridPaper overlay that paints a baseline grid
Material apps.
final
hashCode
→ int
The hash code for this object.
no setter inherited
highContrastDarkTheme
→ ThemeData ?
The ThemeData to use when a 'dark mode' and 'high contrast' is requested
by the system.
final
highContrastTheme
→ ThemeData ?
The ThemeData to use when 'high contrast' is requested by the system.
final
home
→ Widget ?
The widget for the default route of the app (Navigator.defaultRouteName ,
which is /
).
final
initialRoute
→ String ?
The name of the first route to show, if a Navigator is built.
final
key
→ Key ?
Controls how one widget replaces another widget in the tree.
final inherited
locale
→ Locale ?
The initial locale for this app's Localizations widget is based
on this value.
final
localeListResolutionCallback
→ LocaleListResolutionCallback ?
This callback is responsible for choosing the app's locale
when the app is started, and when the user changes the
device's locale.
final
localeResolutionCallback
→ LocaleResolutionCallback ?
The signature of WidgetsApp.localeResolutionCallback .
final
localizationsDelegates
→ Iterable <LocalizationsDelegate > ?
The delegates for this app's Localizations widget.
final
navigatorKey
→ GlobalKey <NavigatorState > ?
A key to use when building the Navigator .
final
navigatorObservers
→ List <NavigatorObserver > ?
The list of observers for the Navigator created for this app.
final
onGenerateInitialRoutes
→ InitialRouteListFactory ?
The routes generator callback used for generating initial routes if
initialRoute is provided.
final
onGenerateRoute
→ RouteFactory ?
The route generator callback used when the app is navigated to a
named route.
final
onGenerateTitle
→ GenerateAppTitle ?
If non-null this callback function is called to produce the app's
title string, otherwise title is used.
final
onNavigationNotification
→ NotificationListenerCallback <NavigationNotification > ?
The callback to use when receiving a NavigationNotification .
final
onUnknownRoute
→ RouteFactory ?
Called when onGenerateRoute fails to generate a route, except for the
initialRoute .
final
pipParams
→ PiPParams
final
restorationScopeId
→ String ?
The identifier to use for state restoration of this app.
final
routeInformationParser
→ RouteInformationParser <Object > ?
A delegate to parse the route information from the
routeInformationProvider into a generic data type to be processed by
the routerDelegate at a later stage.
final
routeInformationProvider
→ RouteInformationProvider ?
A object that provides route information through the
RouteInformationProvider.value and notifies its listener when its value
changes.
final
routerApp
→ bool
final
routerConfig
→ RouterConfig <Object > ?
An object to configure the underlying Router .
final
routerDelegate
→ RouterDelegate <Object > ?
A delegate that configures a widget, typically a Navigator , with
parsed result from the routeInformationParser .
final
routes
→ Map <String , WidgetBuilder > ?
The application's top-level routing table.
final
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
scaffoldMessengerKey
→ GlobalKey <ScaffoldMessengerState > ?
A key to use when building the ScaffoldMessenger .
final
scrollBehavior
→ ScrollBehavior ?
The default ScrollBehavior for the application.
final
shortcuts
→ Map <ShortcutActivator , Intent > ?
The default map of keyboard shortcuts to intents for the application.
final
showPerformanceOverlay
→ bool
Turns on a performance overlay.
final
showSemanticsDebugger
→ bool
Turns on an overlay that shows the accessibility information
reported by the framework.
final
supportedLocales
→ Iterable <Locale >
The list of locales that this app has been localized for.
final
theme
→ ThemeData ?
Default visual properties, like colors fonts and shapes, for this app's
material widgets.
final
themeAnimationCurve
→ Curve
The curve to apply when animating theme changes.
final
themeAnimationDuration
→ Duration
The duration of animated theme changes.
final
themeAnimationStyle
→ AnimationStyle ?
Used to override the theme animation curve and duration.
final
themeMode
→ ThemeMode ?
Determines which theme will be used by the application if both theme
and darkTheme are provided.
final
title
→ String
A one-line description used by the device to identify the app for the user.
final
useInheritedMediaQuery
→ bool
Deprecated. This setting is now ignored.
final