M3ENavigationRailController class

Selects a destination and expands, collapses, or hides the rail.

Pass it to M3ENavigationRail.controller. select runs the rail's onDestinationSelected. index follows the rail's selected index.

Inheritance

Constructors

M3ENavigationRailController({int index = 0, bool expanded = true, bool visible = true})
Creates a controller at index.

Properties

expanded ↔ bool
Whether the rail is expanded.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
index ↔ int
Selected destination index.
getter/setter pair
isAttached → bool
Whether attach has been called.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
visible ↔ bool
Whether an immersive rail is shown.
getter/setter pair

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
attach({required ValueChanged<int> select, required ValueChanged<bool> setExpanded, required ValueChanged<bool> setVisible, required int index, required bool expanded, required bool visible}) → void
Binds the rail.
collapse() → void
Collapses the rail.
detach(ValueChanged<int> select) → void
Drops the rail when select is still the bound callback.
dispose() → void
Discards any resources used by the object.
inherited
expand() → void
Expands the rail.
hide() → void
Hides an immersive rail.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
select(int index) → void
Asks the attached rail to select index.
show() → void
Shows an immersive rail.
toggle() → void
Switches between expanded and collapsed.
toString() → String
A string representation of this object.
inherited
updateExpanded({required bool expanded}) → void
Stores whether the rail is expanded.
updateIndex(int index) → void
Stores the rail's current index.
updateVisible({required bool visible}) → void
Stores whether an immersive rail is shown.

Operators

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