Routable class
An annotation class used to mark a class / view as routable.
The Routable class is used to annotate a class that can be navigated to within a routing system. It provides options for configuring the navigation behavior, such as whether to navigate to the view, replace the current route with the view, or make a root navigation to the view.
The path parameter can be used to specify a custom path for the routable class. The pageRouteBuilder parameter can be used to specify a custom page route builder for the routable class. The routeBuilder parameter can be used to specify a custom route builder for the routable class. When a pageRouteBuilder is provided, the routeBuilder is ignored. The navigateToExtension defines whether the method extension on the navigation service contains a navigateTo method. The replaceWithExtension defines whether the method extension on the navigation service contains a replaceWith method. The rootToExtension defines whether the method extension on the navigation service contains a rootTo method.
Example usage:
@Routable(
replaceWithExtension: false,
rootToExtension: false,
path: '/home',
routeBuilder: RouteBuilder.leftToRight,
)
class MyRoutableClass extends FluorFlowView {
// class implementation
}
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
final
- pageRouteBuilder → Type?
-
final
- path → String?
-
final
- replaceWithExtension → bool
-
final
- rootToExtension → bool
-
final
- routeBuilder → RouteBuilder
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited