PlexApp class

PlexApp is the main app widget that will hold all your app

Inheritance
Available extensions

Constructors

PlexApp({Key? key, required PlexAppInfo appInfo, PlexDashboardConfig? dashboardConfig, List<PlexRoute>? pages, Color themeFromColor = const Color(0xFF007AD7), ImageProvider<Object>? themeFromImage, PlexRoute? unknownRoute, bool useAuthorization = false, Widget customDrawerHeader()?, Widget generateDrawerNavigationButton(PlexRoute plexRoute)?, PlexLoginConfig? loginConfig, dynamic onInitializationComplete()?, dynamic onLogout()?, bool forceMaterial3 = false, PlexScrollBehavior? scrollBehaviour})

Properties

appInfo → PlexAppInfo
This appInfo will be show ass Application title
final
customDrawerHeader → Widget Function()?
Use this widget to create custom drawer header
final
dashboardConfig → PlexDashboardConfig?
final
forceMaterial3 → bool
forceMaterial3 will force app theme to use material3
final
generateDrawerNavigationButton → Widget Function(PlexRoute plexRoute)?
Use this callback to create custom drawer navigation buttons
final
hashCode → int
The hash code for this object.
no setterinherited
imageColorScheme ↔ ColorScheme
getter/setter pair
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loginConfig → PlexLoginConfig?
If useAuthorization is enable set the required inputs by initializing loginConfig
final
onInitializationComplete → dynamic Function()?
When plex application is initialized this method will be called
final
onLogout → dynamic Function()?
When plex user is logout this method will be called
final
pages → List<PlexRoute>?
This pages list will contains all the pages routes information for Application
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollBehaviour → PlexScrollBehavior?
scrollBehaviour will force app to use provided scroll behaviour
final
themeFromColor → Color
This color will be used to generate app theme
final
themeFromImage → ImageProvider<Object>?
This image will be used to generate app theme
final
unknownRoute → PlexRoute?
This unknownRoute will contains Error404 or NotFound screen for Application
final
useAuthorization → bool
Use this trigger to enable authorization in the applicaiton
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PlexApp>
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
getInitialPath() → String
Get AppLogo Based on Brightness Mode of Theme
getNotifications() → List<PlexNotification>
getUser() → PlexUser?
Check the user is logged into the app or not
hideDashboardLoading() → dynamic
Hide loading on Dashboard Screen If Available and Visible
isDashboardLoading() → bool
Check Dashboard Screen Is Loading if Available and Visible
logout() → dynamic
Logout the user and move user to the sign-in screen
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
plexRxWidget(PlexRx rx) → PlexRxWidget

Available on Widget, provided by the PlexRxWidgetExt extension

scaleAnim({int durationMillis = 500, bool repeat = false}) → Widget

Available on Widget, provided by the WidgetsUtils extension

scaleAnim2({int durationMillis = 500, bool repeat = false}) → Widget

Available on Widget, provided by the WidgetsUtils extension

setNotifications(List<PlexNotification> notifications) → void
showAboutDialogue(BuildContext context) → void
showDashboardLoading() → dynamic
Show loading on Dashboard Screen If Available and Visible
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, int wrapWidth = 65}) → 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
updateDashboardUIAlert(Widget? widget) → void
updateUser(PlexUser user) → void

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

app ↔ PlexApp
This is a the app instance to access public variable of app anywhere in the applicaiton.
getter/setter pair