ArnaApp class
An application that uses Arna design.
It builds upon a WidgetsApp by Arna specific defaulting such as fonts and scrolling physics.
The ArnaApp configures the top-level Navigator to search for routes in the following order:
-
For the
/
route, the home property, if non-null, is used. -
Otherwise, the routes table is used, if it has an entry for the route.
-
Otherwise, onGenerateRoute is called, if provided. It should return a non-null value for any valid route not handled by home and routes.
-
Finally if all else fails onUnknownRoute is called.
If home, routes, onGenerateRoute, and onUnknownRoute are all null, and builder is not null, then no Navigator is created.
This widget also configures the observer of the top-level Navigator (if any) to perform Hero animations.
The ArnaApp widget isn't a required ancestor for other Arna widgets, but many Arna widgets could depend on the ArnaTheme widget, which the ArnaApp composes.
{@tool snippet} This example shows how to create an ArnaApp that disables the "debug" banner with a home route that will be displayed when the app is launched.
const ArnaApp(
home: ArnaScaffold(
body: ArnaBody(),
),
debugShowCheckedModeBanner: false,
)
{@end-tool}
{@tool snippet}
This example shows how to create an ArnaApp that uses the routes Map
to define the "home" route and an
"about" route.
ArnaApp(
routes: <String, WidgetBuilder>{
'/': (BuildContext context) {
return const ArnaScaffold(
body: ArnaBody(),
);
},
'/about': (BuildContext context) {
return const ArnaScaffold(
body: ArnaBody(),
);
}
},
)
{@end-tool}
{@tool snippet} This example shows how to create an ArnaApp that defines a theme that will be used for Arna widgets in the app.
const ArnaApp(
theme: ArnaThemeData(
brightness: Brightness.dark,
),
home: ArnaScaffold(
body: ArnaBody(),
),
)
{@end-tool}
See also:
- ArnaScaffold, which provides a standard page layout.
- Navigator, which is used to manage the app's stack of pages.
- WidgetsApp, which defines the basic app elements but does not depend on the Arna library.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ArnaApp
Constructors
-
ArnaApp({Key? key, Widget? home, ArnaThemeData? theme, Map<
String, WidgetBuilder> routes = const <String, WidgetBuilder>{}, String? initialRoute, RouteFactory? onGenerateRoute, InitialRouteListFactory? onGenerateInitialRoutes, RouteFactory? onUnknownRoute, TransitionBuilder? builder, String title = '', GenerateAppTitle? onGenerateTitle, Color? color, Locale? locale, Iterable<LocalizationsDelegate> ? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, Iterable<Locale> supportedLocales = const <Locale>[Locale('en', 'US')], bool showPerformanceOverlay = false, bool checkerboardRasterCacheImages = false, bool checkerboardOffscreenLayers = false, bool showSemanticsDebugger = false, bool debugShowCheckedModeBanner = true, Map<ShortcutActivator, Intent> ? shortcuts, Map<Type, Action< ? actions, String? restorationScopeId, ScrollBehavior? scrollBehavior, bool useInheritedMediaQuery = false})Intent> > -
Creates an ArnaApp.
const
-
ArnaApp.router({Key? key, RouteInformationProvider? routeInformationProvider, required RouteInformationParser<
Object> routeInformationParser, required RouterDelegate<Object> routerDelegate, BackButtonDispatcher? backButtonDispatcher, ArnaThemeData? theme, TransitionBuilder? builder, String title = '', GenerateAppTitle? onGenerateTitle, Color? color, Locale? locale, Iterable<LocalizationsDelegate> ? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, Iterable<Locale> supportedLocales = const <Locale>[Locale('en', 'US')], bool showPerformanceOverlay = false, bool checkerboardRasterCacheImages = false, bool checkerboardOffscreenLayers = false, bool showSemanticsDebugger = false, bool debugShowCheckedModeBanner = true, Map<ShortcutActivator, Intent> ? shortcuts, Map<Type, Action< ? actions, String? restorationScopeId, ScrollBehavior? scrollBehavior, bool useInheritedMediaQuery = false})Intent> > -
Creates an ArnaApp that uses the Router instead of a Navigator.
const
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
- 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
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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.
finalinherited
- 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
-
A key to use when building the Navigator.
final
-
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
- onUnknownRoute → RouteFactory?
-
Called when onGenerateRoute fails to generate a route, except for the
initialRoute.
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
-
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 setterinherited
- scrollBehavior → ScrollBehavior?
-
Used by ScrollConfiguration to configure the Scrollable widgets in a
subtree.
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 → ArnaThemeData?
-
The top-level ArnaTheme styling.
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
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ArnaApp> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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 DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
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 ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
createArnaHeroController(
) → HeroController - The HeroController used for Arna page transitions.