NeuronNavigator class

Inheritance
Available extensions

Properties

canGoBack Computed<bool>
latefinal
canGoForward Signal<bool>
latefinal
currentRoute Signal<NeuronRouteState?>
latefinal
hashCode int
The hash code for this object.
no setterinherited
isNavigating Signal<bool>
latefinal
latefinal
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

$<T>(T initial, {String? debugLabel, bool equals(T prev, T next)?, T guard(T current, T next)?, VoidCallback? onListen, VoidCallback? onCancel}) Signal<T>

Available on NeuronController, provided by the NeuronControllerShorthand extension

Creates a Signal with ultra-short syntax.
$async<T>({T? initial, String? debugLabel}) AsyncSignal<T>

Available on NeuronController, provided by the NeuronControllerShorthand extension

Creates an AsyncSignal with ultra-short syntax.
$computed<T>(T computation(), {String? debugLabel}) Computed<T>

Available on NeuronController, provided by the NeuronControllerShorthand extension

Creates a Computed signal with ultra-short syntax.
addMiddleware(NeuronNavigationMiddleware middleware) → void
asyncSignal<T>({T? initial, String? debugLabel}) AsyncSignal<T>

Available on NeuronController, provided by the NeuronControllerSignals extension

Creates an AsyncSignal and automatically binds it to this controller.
back<T>([T? result]) Future<void>
clearHistory() → void
computed<T>(T computation(), {String? debugLabel}) Computed<T>

Available on NeuronController, provided by the NeuronControllerSignals extension

Creates a Computed signal and automatically binds it to this controller.
dispose() → void
Disposes all registered notifiers and calls onClose.
inherited
effect(void callback(), List<NeuronAtom> dependencies, {bool fireImmediately = true}) → void
Run a side effect whenever dependencies change.
inherited
forward() Future<void>
getCurrentRoute() NeuronRoute?
getCurrentRouteState() NeuronRouteState?
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
offAllNamed<T>(String name, {Map<String, dynamic> params = const {}, Map<String, dynamic> query = const {}, Object? arguments}) Future<T?>
onClose() → void
Called right before the controller is disposed.
inherited
onInit() → void
Called once after the controller is installed via Neuron.install or Neuron.ensure.
inherited
popUntil(String routeName) → void
registerRoutes(List<NeuronRoute> routes, {bool reset = false}) → void
signal<T>(T initial, {String? debugLabel, bool equals(T prev, T next)?, T guard(T current, T next)?, VoidCallback? onListen, VoidCallback? onCancel}) Signal<T>

Available on NeuronController, provided by the NeuronControllerSignals extension

Creates a Signal and automatically binds it to this controller.
to<T>(String path, {Map<String, dynamic> query = const {}, bool replace = false, Object? arguments}) Future<T?>
toNamed<T>(String name, {Map<String, dynamic> params = const {}, Map<String, dynamic> query = const {}, bool replace = false, Object? arguments}) Future<T?>
toString() String
A string representation of this object.
inherited
toUri<T>(Uri uri, {bool replace = false, Object? arguments}) Future<T?>

Operators

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

Static Properties

instance NeuronNavigator
no setter