CupertinoApp class Null safety

An application that uses Cupertino design.

A convenience widget that wraps a number of widgets that are commonly required for an iOS-design targeting application. It builds upon a WidgetsApp by iOS specific defaulting such as fonts and scrolling physics.

The CupertinoApp configures the top-level Navigator to search for routes in the following order:

  1. For the / route, the home property, if non-null, is used.

  2. Otherwise, the routes table is used, if it has an entry for the route.

  3. Otherwise, onGenerateRoute is called, if provided. It should return a non-null value for any valid route not handled by home and routes.

  4. 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 CupertinoApp widget isn't a required ancestor for other Cupertino widgets, but many Cupertino widgets could depend on the CupertinoTheme widget, which the CupertinoApp composes. If you use Material widgets, a MaterialApp also creates the needed dependencies for Cupertino widgets.

Use this widget with caution on Android since it may produce behaviors Android users are not expecting such as:

  • Pages will be dismissible via a back swipe.
  • Scrolling past extremities will trigger iOS-style spring overscrolls.
  • The San Francisco font family is unavailable on Android and can result in undefined font behavior.

This example shows how to create a CupertinoApp that disables the "debug" banner with a home route that will be displayed when the app is launched.

The CupertinoApp displays a CupertinoPageScaffold

const CupertinoApp(
  home: CupertinoPageScaffold(
    navigationBar: CupertinoNavigationBar(
      middle: Text('Home'),
    ),
    child: Center(child: Icon(CupertinoIcons.share)),
  ),
  debugShowCheckedModeBanner: false,
)

This example shows how to create a CupertinoApp that uses the routes Map to define the "home" route and an "about" route.
CupertinoApp(
  routes: <String, WidgetBuilder>{
    '/': (BuildContext context) {
      return const CupertinoPageScaffold(
        navigationBar: CupertinoNavigationBar(
          middle: Text('Home Route'),
        ),
        child: Center(child: Icon(CupertinoIcons.share)),
      );
    },
    '/about': (BuildContext context) {
      return const CupertinoPageScaffold(
        navigationBar: CupertinoNavigationBar(
          middle: Text('About Route'),
        ),
        child: Center(child: Icon(CupertinoIcons.share)),
      );
    }
  },
)

This example shows how to create a CupertinoApp that defines a theme that will be used for Cupertino widgets in the app.

The CupertinoApp displays a CupertinoPageScaffold with orange-colored icons

const CupertinoApp(
  theme: CupertinoThemeData(
    brightness: Brightness.dark,
    primaryColor: CupertinoColors.systemOrange,
  ),
  home: CupertinoPageScaffold(
    navigationBar: CupertinoNavigationBar(
      middle: Text('CupertinoApp Theme'),
    ),
    child: Center(child: Icon(CupertinoIcons.share)),
  ),
)

See also:

  • CupertinoPageScaffold, which provides a standard page layout default with nav bars.
  • Navigator, which is used to manage the app's stack of pages.
  • CupertinoPageRoute, which defines an app page that transitions in an iOS-specific way.
  • WidgetsApp, which defines the basic app elements but does not depend on the Cupertino library.
Inheritance

Constructors

CupertinoApp({Key? key, GlobalKey<NavigatorState>? navigatorKey, Widget? home, CupertinoThemeData? theme, Map<String, Widget Function(BuildContext)> routes, String? initialRoute, RouteFactory? onGenerateRoute, InitialRouteListFactory? onGenerateInitialRoutes, RouteFactory? onUnknownRoute, List<NavigatorObserver> navigatorObservers, TransitionBuilder? builder, String title, GenerateAppTitle? onGenerateTitle, Color? color, Locale? locale, Iterable<LocalizationsDelegate>? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, Iterable<Locale> supportedLocales, bool showPerformanceOverlay, bool checkerboardRasterCacheImages, bool checkerboardOffscreenLayers, bool showSemanticsDebugger, bool debugShowCheckedModeBanner, Map<LogicalKeySet, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, String? restorationScopeId, ScrollBehavior? scrollBehavior})
Creates a CupertinoApp. [...]
const
CupertinoApp.router({Key? key, RouteInformationProvider? routeInformationProvider, required RouteInformationParser<Object> routeInformationParser, required RouterDelegate<Object> routerDelegate, BackButtonDispatcher? backButtonDispatcher, CupertinoThemeData? theme, TransitionBuilder? builder, String title, GenerateAppTitle? onGenerateTitle, Color? color, Locale? locale, Iterable<LocalizationsDelegate>? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, Iterable<Locale> supportedLocales, bool showPerformanceOverlay, bool checkerboardRasterCacheImages, bool checkerboardOffscreenLayers, bool showSemanticsDebugger, bool debugShowCheckedModeBanner, Map<LogicalKeySet, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, String? restorationScopeId, ScrollBehavior? scrollBehavior})
Creates a CupertinoApp 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 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
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
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
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.
read-only, inherited
scrollBehavior ScrollBehavior?
The default ScrollBehavior for the application. [...]
final
shortcuts Map<LogicalKeySet, 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 CupertinoThemeData?
The top-level CupertinoTheme styling. [...]
final
title String
A one-line description used by the device to identify the app for the user. [...]
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
createState() → _CupertinoAppState
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → 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 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. [...]
@nonVirtual, inherited

Static Methods

createCupertinoHeroController() HeroController
The HeroController used for Cupertino page transitions. [...]