PanelIndexScreen class

The panel's resources as a single list: the entry point once a user is signed in.

A plain widget with no router dependency: the host decides where a tap goes, exactly like ResourceListScreen.

A panel with a single resource may be opened directly by the caller instead of showing this index — navigation belongs to the host, so this screen deliberately does not implement that shortcut.

Inheritance

Constructors

PanelIndexScreen({required PanelProvider provider, required void onResourceTap(ResourceSchema resource), Widget? leading(ResourceSchema resource)?, FilamentWidgetRegistry? widgetRegistry, PanelBodyBuilder? stateBuilder, FilamentStrings strings = const FilamentStrings(), Key? key})
const

Properties

hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading Widget? Function(ResourceSchema resource)?
Builds a row's leading widget — typically the icon the host's panel shows for the same resource. The contract carries no icon of its own, so the mapping is the host's: usually a switch on ResourceSchema.key. Null (or a null return for one resource) renders that row without a leading slot, exactly as before this parameter existed.
final
onResourceTap → void Function(ResourceSchema resource)
final
provider PanelProvider
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stateBuilder PanelBodyBuilder?
final
strings FilamentStrings
final
widgetRegistry FilamentWidgetRegistry?
Application-owned widgets inserted into this screen's named slots.
final

Methods

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