StartupPageFactory<T extends StandardPage<StartupPageCompleter>> class base

A special factory class for creating a page used during a StartupSequence. Used for scenarios like creating a consent screen for the user on the first app launch.

Inheritance

• Object
• StandardPageWithResultFactory<T, StartupPageCompleter, void>
• StandardPageFactory<T, StartupPageCompleter>
• StartupPageFactory

Constructors

StartupPageFactory.new({required T create(StartupPageCompleter pageData), bool groupRoot = false, String? group, bool keepHistory = true, bool enableNavigationAnalytics = true, StandardPageNavigationMode navigationMode = StandardPageNavigationMode.moveToTop, LocalKey pageKey(StartupPageCompleter pageData)?, StandardPageInterface<StartupPageCompleter, void> pageBuilder(Widget child, String? name, StartupPageCompleter pageData, LocalKey pageKey, String restorationId, GlobalKey<StandardPageWithResult<StartupPageCompleter, void>> standardPageKey, StandardPageWithResultFactory<StandardPageWithResult<StartupPageCompleter, void>, StartupPageCompleter, void> factoryObject)?, StartupPageCompleter pageDataWhenNull()?, String? pageName()?, String restorationId(StartupPageCompleter pageData)?})

Create a StartupPageFactory

Properties

create → T Function(StartupPageCompleter pageData)

Creates the T page that this factory manages.

final, inherited

dataType → Type

The data type of this page.

no setter, inherited

dataTypeIsNonNullable → bool

Flag indicating that the type of page data set for this page is nullable.

no setter, inherited

enableNavigationAnalytics → bool

Flag indicating whether to enable analytics for navigation.

final, inherited

group → String?

The group name used to manage multiple pages as part of the same group when they exist.

final, inherited

groupRoot → bool

Flag indicating whether to set this page as the root group if a group name is specified.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

keepHistory → bool

Flag indicating whether to stack this page as part of the history or not.

final, inherited

linkGenerator → String Function(StartupPageCompleter pageData)?

The function to create deep links for this page. The return value must match the keys (regular expressions) passed to links and their corresponding R 'pageData' destinations.

final, inherited

navigationMode → StandardPageNavigationMode

The method for transitioning to this page from other pages. Please refer to StandardPageNavigationMode for navigation modes.

final, inherited

pageBuilder → StandardPageInterface<StartupPageCompleter, void> Function(Widget child, String? name, StartupPageCompleter pageData, LocalKey pageKey, String restorationId, GlobalKey<StandardPageWithResult<StartupPageCompleter, void>> standardPageKey, StandardPageWithResultFactory<StandardPageWithResult<StartupPageCompleter, void>, StartupPageCompleter, void> factoryObject)?

A function for creating StandardPageInterface.

final, inherited

pageDataWhenNull → StartupPageCompleter Function()?

A function to generate a replacement value when the pageData passed during navigation is null.

final, inherited

pageName → String? Function()?

The name of this page.

final, inherited

pageType → Type

The page type of this page.

no setter, inherited

parentPageType → Type?

When using nested Navigators, specifies what the parent page Type of this child page should be.

final, inherited

restorationId → String Function(StartupPageCompleter pageData)?

A function for generating a value to pass to Page.restorationId.

final, inherited

resultType → Type

The result type of this page.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

generateLink(Object? pageData) → String?

Returns the deep link generated by this page given pageData.

inherited

getPageKey(Object? pageData) → LocalKey

Get the key set for this page, as configured for this page.

inherited

goWithResult(StartupPageCompleter pageData, [StandardPageNavigationMode? navigationMode]) → Future<void>

Navigate to the StandardPage of type T with the option to pass pageData during navigation. An optional navigationMode representing the mode of StandardPageNavigationMode to use during navigation can also be provided.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited