AdminDashboard class

Inheritance

Constructors

AdminDashboard({Key? key, required ServerpodClientShared client, String title = 'Serverpod Admin Dashboard', ThemeMode initialThemeMode = ThemeMode.system, ThemeData? lightTheme, ThemeData? darkTheme, SidebarBuilder? customSidebarBuilder, Map<String, SidebarItemCustomization>? sidebarItemCustomizations, BodyBuilder? customBodyBuilder, DetailsBuilder? customDetailsBuilder, EditDialogBuilder? customEditDialogBuilder, DeleteDialogBuilder? customDeleteDialogBuilder, CreateDialogBuilder? customCreateDialogBuilder, FooterBuilder? customFooterBuilder, Future<bool> onLogin(String username, String password)?, String? loginTitle, String? loginSubtitle})
const

Properties

client → ServerpodClientShared
final
customBodyBuilder → BodyBuilder?
Optional custom body/records pane builder. If provided, replaces the default records pane.
final
customCreateDialogBuilder → CreateDialogBuilder?
Optional custom create/new record dialog builder. If provided, replaces the default create dialog.
final
customDeleteDialogBuilder → DeleteDialogBuilder?
Optional custom delete confirmation dialog builder. If provided, replaces the default delete dialog.
final
customDetailsBuilder → DetailsBuilder?
Optional custom record details builder. If provided, replaces the default record details view.
final
customEditDialogBuilder → EditDialogBuilder?
Optional custom edit/update dialog builder. If provided, replaces the default edit dialog.
final
customFooterBuilder → FooterBuilder?
Optional custom footer builder. If provided, the custom footer will be displayed above the default footer. The default footer is always shown and cannot be changed.
final
customSidebarBuilder → SidebarBuilder?
Optional custom sidebar builder. If provided, replaces the default sidebar.
final
darkTheme → ThemeData?
final
hashCode → int
The hash code for this object.
no setterinherited
initialThemeMode → ThemeMode
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lightTheme → ThemeData?
final
loginSubtitle → String?
Login screen subtitle.
final
loginTitle → String?
Login screen title. Defaults to 'Serverpod Admin'.
final
onLogin → Future<bool> Function(String username, String password)?
Optional login callback. If provided, a login screen will be shown first. The callback receives username and password and should return true if login is successful, false otherwise.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sidebarItemCustomizations → Map<String, SidebarItemCustomization>?
Optional map of sidebar item customizations. Key is the resource key, value contains custom label and icon. Example: {'users': SidebarItemCustomization(label: 'Users', icon: Icons.people)}
final
title → String
final

Methods

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

Operators

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