RouteModule class abstract

Abstract base for service UI modules that contribute routes and navigation items to a host application.

Each service UI package exports a concrete RouteModule implementation. The host app composes them:

final modules = [ProfileRouteModule(), PaymentRouteModule(), ...];
ShellRoute(
  routes: [...ownRoutes, for (final m in modules) ...m.buildRoutes()],
)

Constructors

RouteModule()

Properties

hashCode → int
The hash code for this object.
no setterinherited
moduleId → String
Unique identifier (e.g., 'profile', 'payment', 'files').
no setter
permissionManifest → PermissionManifest?
Permission manifest declaring all proto-defined permissions this module uses. Override to declare granular permissions for batch checking.
no setter
routePermissions → Map<String, Set<String>>
Route permission map. Keys are route prefixes, values are sets of role strings required to access that route.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

buildNavItems() → List<NavItem>
Navigation items for the sidebar.
buildRoutes() → List<RouteBase>
GoRouter route trees to be merged into the host app's router.
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