ThemedMiniBar class

Inheritance

Constructors

ThemedMiniBar({Key? key, List<ThemedNavigatorItem> items = const [], List<ThemedNavigatorItem> persistentItems = const [], bool enableAbout = true, VoidCallback? onSettingsTap, VoidCallback? onProfileTap, VoidCallback? onLogoutTap, VoidCallback? onThemeSwitchTap, required String appTitle, String companyName = 'Golden M, Inc', required AppThemedAsset favicon, String userName = "Golden M", String? userAvatar, Avatar? userDynamicAvatar, String? version, List<ThemedNavigatorItem> additionalActions = const [], double mobileBreakpoint = kMediumGrid, Color? backgroundColor, ThemedNavigatorPushFunction? onNavigatorPush, ThemdNavigatorPopFunction? onNavigatorPop, String? currentPath, bool enableNotifications = true, List<ThemedNotificationItem> notifications = const [], String homePath = '/home', double depthColorFactor = 0.15})
ThemedMiniBar is the custom native Drawer
const

Properties

additionalActions → List<ThemedNavigatorItem>
additionalActions is the list of additional actions to be displayed in the drawer. This actions will be displayed before the about, settings, profile and logout buttons.
final
appTitle → String
appTitle is the title of the app.
final
backgroundColor → Color?
backgroundColor is the background color of the drawer. By default is Theme.of(context).primaryColor.
final
companyName → String
companyName is the name of the company.
final
currentPath → String?
currentPath is the current path of the navigator. Overrides the default path detection. By default, we get the current path from ModalRoute.of(context)?.settings.name.
final
depthColorFactor → double
depthColorFactor is the factor to be used to calculate the color of the depth. By default is 0.15.
final
enableAbout → bool
enableAbout is a boolean that enables the about button.
final
enableNotifications → bool
enableNotifications is a boolean that enables the notifications button and page.
final
favicon → AppThemedAsset
favicon is the favicon of the app. Can be a path or a url.
final
hashCode → int
The hash code for this object.
no setterinherited
homePath → String
homePath is the path of the home page.
final
items → List<ThemedNavigatorItem>
items is the list of buttons to be displayed
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
logo is the logo of the app. Can be a path or a url.
final
mobileBreakpoint → double
mobileBreakpoint is the breakpoint to be used to determine if the device is mobile or not. By default is kMediumGrid.
final
notifications → List<ThemedNotificationItem>
notifications is the list of notifications to be displayed in the drawer.
final
onLogoutTap → VoidCallback?
onLogoutTap is the callback to be executed when the logout button
final
onNavigatorPop → ThemdNavigatorPopFunction?
onNavigatorPop is the callback to be executed when the back button is tapped. By default is Navigator.of(context).pop
final
onNavigatorPush → ThemedNavigatorPushFunction?
onNavigatorPush is the callback to be executed when a navigator item is tapped. By default is Navigator.of(context).pushNamed
final
onProfileTap → VoidCallback?
onProfileTap is the callback to be executed when the profile button
final
onSettingsTap → VoidCallback?
onSettingsTap is the callback to be executed when the settings button
final
onThemeSwitchTap → VoidCallback?
onThemeSwitchTap is a callback that is called when the theme switch button is tapped.
final
persistentItems → List<ThemedNavigatorItem>
persistentItems is the list of buttons to be displayed
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
userAvatar → String?
userAvatar is the avatar of the user. Can be a path or a url.
final
userDynamicAvatar → Avatar?
userDynamicAvatar is the dynamic avatar of the user.
final
userName → String
userName is the name of the user.
final
version → String?
version is the version of the app.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ThemedMiniBar>
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