patapata_widgets library

Classes

InfiniteScrollItemInformation
Provides information about an item in the infinite scroll list.
InfiniteScrollListView<T>
A widget that provides infinite scrolling functionality to ListView or GridView.
PlatformDialog
By calling show, a dialog styled according to each platform will be displayed. This wraps Flutter's showDialog to match the style of each platform.
PlatformDialogAction<T>
The set of actions that are displayed at the bottom of the dialog.
ScreenLayout
A widget that will layout child at the given size in breakpoints. ScreenLayoutBreakpoints.portraitStandardBreakpoint while in portrait mode, or ScreenLayoutBreakpoints.landscapeStandardBreakpoint while in landscape mode. After laying out at that size, ScreenLayout will scale the child so as to fix the current screen size, up to a maximum scale ratio of maxScale, or ScreenLayoutBreakpoints.portraitConstrainedWidth while in portrait mode, or ScreenLayoutBreakpoints.landscapeConstrainedWidth while in landscape mode.
ScreenLayoutBreakpoints
A class representing breakpoints for screen layout. Breakpoints refer to the widths determined by the application's design. You can set the breakpoints for portrait mode and landscape mode (portraitStandardBreakpoint, landscapeStandardBreakpoint), as well as width constraints for portrait mode and landscape mode (portraitConstrainedWidth, landscapeConstrainedWidth). Additionally, by setting maxScale, you can limit the scale to prevent the RenderSize of child elements from exceeding it. Pass these settings to ScreenLayout.breakpoints.
ScreenLayoutDefaultBreakpoints
A class that defines default screen layout breakpoints.
ScreenLayoutDisable
A widget that disables the screen layout of the child widget child.
SplashPageFactory<T extends StandardPage<void>>
This is a special factory class for creating a splash page after app launch, and it is required to collaborate with the functionality of StartupSequence.
StandardAppPlugin
A plugin that embodies the fundamental concepts of Patapata, which includes rules, pages, and settings for app development, known as StandardApp. This plugin is enabled by default. If you want to disable StandardApp, you can remove this plugin using App.removePlugin or disable it through remote configuration settings after running.
StandardCupertinoApp<T>
This class is used to create applications using Cupertino with Patapata. Widgets that have this class as their parent cannot use widgets intended for use with MaterialApp. Properties other than pages, routableBuilder, and willPopPage are the same as CupertinoApp.
StandardCustomPage<R, E>
Implements functionality to extend Page and create a customized StandardPageWithResult.
StandardErrorPageFactory<T extends StandardPage<ReportRecord>>
A special factory class for creating an error page that PatapataException can navigate to if an error has a PatapataException.userLogLevel of Level.SHOUT.
StandardMaterialApp<T>
This class is used to create applications using Material Design with Patapata. Widgets that have this class as their parent cannot use widgets intended for use with CupertinoApp. Properties other than pages, routableBuilder, and willPopPage are properties to be passed to MaterialApp.router.
StandardMaterialPage<R extends Object?, E extends Object?>
Implements functionality to extend MaterialPage and create a StandardPage.
StandardPage<T extends Object?>
This class is used to create pages that return values when building an application with Patapata.
StandardPageBackButton
A back button specified at the top of the AppBar of a child page, which includes multiple navigators, in both Material and Cupertino Design.
StandardPageFactory<T extends StandardPage<R>, R extends Object?>
Factory class for StandardPage to be set in the page property of StandardMaterialApp. T is the type of the destination page, and R is the type of page data. The following source code is an example of passing StandardPageFactory to StandardMaterialApp.pages.
StandardPageWithResult<T extends Object?, E extends Object?>
This class is used to create pages that return values when building an application with Patapata.
StandardPageWithResultFactory<T extends StandardPageWithResult<R, E>, R extends Object?, E extends Object?>
A factory class for creating StandardPageWithResult instances that returns a value E. This class can be added to the pages property of StandardMaterialApp.new or StandardCupertinoApp.new. T is the Represents the data type of the destination page, R is the Represents the data type of the page data, E is the Represents the data type of the value returned by the page.
StandardRouteData
A data class to be specified when implementing Patapata's Router using StandardRouterDelegate.
StandardRouteInformationParser
A class that implements RouteInformationParser necessary for Patapata's Router.
StandardRouterDelegate
A class that implements RouterDelegate required for Patapata's Router.
StartupPageFactory<T extends StandardPage<StartupPageCompleter>>
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.
WebPageNotFound

Enums

StandardAppType
Whether to use the Material app or the Cupertino app to design
StandardPageNavigationMode
Specifies how pages created with StandardPageFactory should be navigated

Mixins

ScreenLayoutEnvironment
Application screen layout settings. Used in ScreenLayout.breakpoints.
StandardAppEnvironment
Settings for StandardAppPlugin.
StandardAppRoutePluginMixin
A mixin for enabling integration between the 'Patapata' Route system and Plugin, including routing and initialization processes. The method implemented in this mixin is called within the processing of StandardRouterDelegate.processInitialRoute when transitioning to the initial page after the app is launched.
StandardPageInterface<R extends Object?, E extends Object?>
A mixin for creating a Page that creates StandardPageWithResult.
StandardPagePluginMixin
A mixin for allowing a Plugin to modify how a StandardPage or StandardPageWithResult works.
StandardStatefulMixin
This is a mixin for StatefulWidget that is needed to create a WidgetsApp.Router for Patapata. If you want to create your own WidgetsApp.Router, you can refer to StandardMaterialApp or StandardCupertinoApp.
StandardWidgetAppMixin<T extends StandardStatefulMixin>
This is a mixin for State that is needed to create a WidgetsApp.Router for Patapata. If you want to create your own WidgetsApp.Router, you can refer to StandardMaterialApp or StandardCupertinoApp.

Extensions

ScreenLayoutContext on BuildContext
An extension class that adds the screen layout scaling functionality to BuildContext.
StandardAppApp on App<Object>
An extension class that adds references to the Router and Plugin functionalities of StandardApp to App.
StandardAppRouter on Router
An extension class that adds the Router functionality of StandardApp to Router.
StandardAppRouterContext on BuildContext
An extension class that adds the Router functionality of StandardApp to BuildContext.

Typedefs

StandardAppPluginLinkHandlerKey = Object
A typedef for the key of a LinkHandler used in StandardAppPlugin.