A convenience class that wraps a number of widgets that are commonly required for an application.

One of the primary roles that WidgetsApp provides is binding the system back button to popping the Navigator or quitting the application.

See also: CheckedModeBanner, DefaultTextStyle, MediaQuery, Localizations, Title, Navigator, Overlay, SemanticsDebugger (the widgets wrapped by this one).

The onGenerateRoute argument is required, and corresponds to Navigator.onGenerateRoute.

Inheritance

Constructors

WidgetsApp({Key key, @required RouteFactory onGenerateRoute, RouteFactory onUnknownRoute, String title: '', GenerateAppTitle onGenerateTitle, TextStyle textStyle, @required Color color, List<NavigatorObserver> navigatorObservers: const [], String initialRoute, Locale locale, Iterable<LocalizationsDelegate> localizationsDelegates, LocaleResolutionCallback localeResolutionCallback, Iterable<Locale> supportedLocales: const [const Locale('en', 'US')], bool showPerformanceOverlay: false, bool checkerboardRasterCacheImages: false, bool checkerboardOffscreenLayers: false, bool showSemanticsDebugger: false, bool debugShowWidgetInspector: false, bool debugShowCheckedModeBanner: true, InspectorSelectButtonBuilder inspectorSelectButtonBuilder })
Creates a widget that wraps a number of widgets that are commonly required for an application. [...]

Properties

checkerboardOffscreenLayers bool
Checkerboards layers rendered to offscreen bitmaps. [...]
final
checkerboardRasterCacheImages bool
Checkerboards raster cache images. [...]
final
color Color
The primary color to use for the application in the operating system interface. [...]
final
debugShowCheckedModeBanner bool
Turns on a "SLOW MODE" little banner in checked mode to indicate that the app is in checked mode. This is on by default (in checked mode), to turn it off, set the constructor argument to false. In release mode this has no effect. [...]
final
debugShowWidgetInspector bool
Turns on an overlay that enables inspecting the widget tree. [...]
final
initialRoute String
The name of the first route to show. [...]
final
inspectorSelectButtonBuilder InspectorSelectButtonBuilder
Builds the widget the WidgetInspector uses to switch between view and inspect modes. [...]
final
locale Locale
The initial locale for this app's Localizations widget. [...]
final
localeResolutionCallback LocaleResolutionCallback
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
localizationsDelegates Iterable<LocalizationsDelegate>
The delegates for this app's Localizations widget. [...]
final
The list of observers for the Navigator created for this app.
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
onUnknownRoute RouteFactory
Called when onGenerateRoute fails to generate a route. [...]
final
showPerformanceOverlay bool
Turns on a performance overlay. https://flutter.io/debugging/#performanceoverlay
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
textStyle TextStyle
The default text style for Text in the application.
final
title String
A one-line description used by the device to identify the app for the user. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → _WidgetsAppState
Creates the mutable state for this widget at a given location in the tree. [...]
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder description) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this node and its descendants. [...]
inherited
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a one-line detailed description of the object. [...]
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(other) bool
The equality operator. [...]
inherited

Static Properties

debugAllowBannerOverride bool
If false, prevents the debug banner from being visible. [...]
read / write
debugShowWidgetInspectorOverride bool
If true, forces the widget inspector to be visible. [...]
read / write
showPerformanceOverlayOverride bool
If true, forces the performance overlay to be visible in all instances. [...]
read / write