hypen library

Classes

AddPreviewInputField
Autodispose
Completer<T>
A way to produce Future objects and to complete them later with a value or error.
CustomTransitionPage<T>
Page with custom transition functionality.
EventSink<T>
A Sink that supports adding errors.
Future<T>
The result of an asynchronous computation.
FutureOr<T>
A type representing values that are either Future<T> or T.
GoRoute Get started Configuration Redirection Transition animations Named routes
A route that is displayed visually above the matching parent route using the Navigator.
GoRouteData Type-safe routes
A class to represent a GoRoute in Type-safe routing.
GoRouteInformationParser
Converts between incoming URLs and a RouteMatchList using RouteMatcher. Also performs redirection using RouteRedirector.
GoRouteInformationProvider
The RouteInformationProvider created by go_router.
GoRouter Get started Upgrading Configuration Navigation Redirection Web Deep linking Named routes Error handling
The route configuration for the app.
GoRouterDelegate
GoRouter implementation of RouterDelegate.
GoRouterState
The route state during routing.
HypenCustomTransition
HypenErrorPage
HypenLayoutState<T extends HypenStatefulLayoutWidget>
HypenLayoutWidget
HypenPageWidget
HypenPath
HypenStatefulLayoutWidget
HypenStatefulPageState<T extends HypenStatefulPageWidget>
HypenStatefulPageWidget
HypenStatefulTemplateWidget
HypenTemplateState<T extends HypenStatefulTemplateWidget>
HypenTemplateWidget
HypenWidgetWithChild
ImperativeRouteMatch
The route match that represent route pushed through GoRouter.push.
InheritedGoRouter
GoRouter implementation of InheritedWidget.
InitialLocation
MultiStreamController<T>
An enhanced stream controller provided by Stream.multi.
NotObservable
NoTransitionPage<T>
Custom transition page with no transition.
Observable
PredefinedPreviewInputFields
Preview
PreviewBuilder
PreviewText
PreviewWidget
PreviewWidgetState
RouteBase
The base class for GoRoute and ShellRoute.
RouteBuilder
Builds the top-level Navigator for GoRouter.
RouteConfiguration
The route configuration for GoRouter configured by the app.
RouteData
Baseclass for supporting Type-safe routing.
RouteInformationState<T>
The data class to be stored in RouteInformation.state to be used by GoRouteInformationParser.
RouteMatch
An matched result by matching a GoRoute against a location.
RouteMatchBase
The base class for various route matches.
RouteMatchList
The list of RouteMatchBase objects.
RoutingConfig Configuration
A set of parameters that defines routing in GoRouter.
SaveAction
An action to run with SaveObserver.
SaveAction0<T>
An action to run with SaveObserver.
SaveAction1<T, A>
An action to run with SaveObserver.
SaveAction2<T, A, B>
An action to run with SaveObserver.
SaveAction3<T, A, B, C>
An action to run with SaveObserver.
SaveAction4<T, A, B, C, D>
An action to run with SaveObserver.
SaveAction5<T, A, B, C, D, E>
An action to run with SaveObserver.
SaveAction6<T, A, B, C, D, E, F>
An action to run with SaveObserver.
SaveActionEffect
Effects for actions.
SaveActionEffect0
Effects for action
SaveActionEffect1<A>
Effects for action1
SaveActionEffect2<A, B>
Effects for action2
SaveActionEffect3<A, B, C>
Effects for action3
SaveActionEffect4<A, B, C, D>
Effects for action4
SaveActionEffect5<A, B, C, D, E>
Effects for action5
SaveActionEffect6<A, B, C, D, E, F>
Effects for action6
SaveBuilder
A Builder to use SaveObserver.
SaveEffect
Base class for effects.
SaveEffectWithObserver
SaveFromFamilyEffect<T, A>
The effects runs on SaveObservable from save.withArg
SaveFromFamilyLoader<T, A>
Hooks the initialization of the SaveObservable from SaveProviderFromFamily.
SaveLoader
Base class for loaders.
SaveObservable<T>
SaveObservableBase<T>
Developer-faced observable state class.
SaveObservableEffect<T>
The effect runs on SaveObservable.
SaveObservableImpl<T>
Raw implementaion of the observable.
SaveObservableLoader<T>
Hooks the initialization of the SaveObservable from SaveProvider.
SaveProvider<T>
Provides the key and the observable for the state.
SaveProviderFromFamily<T, A>
Providers created by the family.
SaveReactiveFromFamilyEffect<T, A>
The effects runs on SaveObservable from save.withArg with Saveobserver.
SaveReactiveFromFamilyLoader<T, A>
A simple loader for SaveReactiveProviderFromFamily.
SaveReactiveLoader<T>
A simple loader for SaveReactiveProvider.
SaveReactiveObservable<T>
An observable that can watch others.
SaveReactiveObservableEffect<T>
The effect runs on SaveObservable with SaveObserver.
SaveReactiveProvider<T>
SaveReactiveProviderFamily<T, A>
Generate SaveReactiveProviders for each arguments.
SaveReactiveProviderFromFamily<T, A>
SaveRepository
The repository holding the state.
SaveRepositoryKey
A key used for identify the SaveObservable stored in the SaveRepository.
SaveScope
A root source of the SaveObservable.
SaveStatefulElement
SaveStatefulWidget
Stateful version of SaveWidget.
SaveStatelessWidgetState
The default widget state to build SaveWidget.
SaveWidget
Reactive widget to use SaveProvider and SaveObservable.
SaveWidgetState<T extends SaveStatefulWidget>
A State for SaveStatefulWidget.
ShellRoute Configuration
A route that displays a UI shell around the matching child route.
ShellRouteBase
Base class for classes that act as shells for sub-routes, such as ShellRoute and StatefulShellRoute.
ShellRouteContext
Context object used when building the shell and Navigator for a shell route.
ShellRouteData
A class to represent a ShellRoute in Type-safe routing.
ShellRouteMatch
An matched result by matching a ShellRoute against a location.
StatefulNavigationShell
Widget for managing the state of a StatefulShellRoute.
StatefulNavigationShellState
State for StatefulNavigationShell.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to configure StatefulShellRoute.
StatefulShellBranchData
Base class for supporting StatefulShellRoute
StatefulShellRoute
A route that displays a UI shell with separate Navigators for its sub-routes.
StatefulShellRouteData
Base class for supporting StatefulShellRoute
Stream<T>
A source of asynchronous data events.
StreamConsumer<S>
Abstract interface for a "sink" accepting multiple entire streams.
StreamController<T>
A controller with the stream it controls.
StreamIterator<T>
An Iterator-like interface for the values of a Stream.
StreamSink<S>
A object that accepts stream events both synchronously and asynchronously.
StreamSubscription<T>
A subscription on events from a Stream.
StreamTransformer<S, T>
Transforms a Stream.
StreamTransformerBase<S, T>
Base class for implementing StreamTransformer.
StreamView<T>
Stream wrapper that only exposes the Stream interface.
SynchronousStreamController<T>
A stream controller that delivers its events synchronously.
Timer
A countdown timer that can be configured to fire once or repeatedly.
TypedGoRoute<T extends GoRouteData>
A superclass for each typed go route descendant
TypedRoute<T extends RouteData>
A superclass for each typed route descendant
TypedShellRoute<T extends ShellRouteData>
A superclass for each typed shell route descendant
TypedStatefulShellBranch<T extends StatefulShellBranchData>
A superclass for each typed shell route descendant
TypedStatefulShellRoute<T extends StatefulShellRouteData>
A superclass for each typed shell route descendant
ValueSet<T>
Zone
A zone represents an environment that remains stable across asynchronous calls.
ZoneDelegate
An adapted view of the parent zone.
ZoneSpecification
A parameter object with custom zone function handlers for Zone.fork.

Enums

The type of the navigation.
SaveEffectType
Types of effect.

Extensions

FutureExtensions on Future<T>
Convenience methods on futures.
FutureIterable on Iterable<Future<T>>
FutureRecord2 on (Future<T1>, Future<T2>)
Parallel operations on a record of futures.
FutureRecord3 on (Future<T1>, Future<T2>, Future<T3>)
Parallel operations on a record of futures.
FutureRecord4 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>)
Parallel operations on a record of futures.
FutureRecord5 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>)
Parallel operations on a record of futures.
FutureRecord6 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>)
Parallel operations on a record of futures.
FutureRecord7 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>)
Parallel operations on a record of futures.
FutureRecord8 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>)
Parallel operations on a record of futures.
FutureRecord9 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>, Future<T9>)
Parallel operations on a record of futures.
GoRouterAdapter on BuildContext
GoRouterHelper on BuildContext
Dart extension to add navigation function to a BuildContext object, e.g. context.go('/');

Constants

autodispose → const Autodispose
hypenPath → const _DummyHypenPath
initialLocation → const InitialLocation
notObservable → const NotObservable
observable → const Observable
preview → const Preview

Properties

hypenPathParameterMap → Map<Object, Object?>
final

Functions

runZoned<R>(R body(), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification, Function? onError}) → R
Runs body in its own zone.
runZonedGuarded<R>(R body(), void onError(Object error, StackTrace stack), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification}) → R?
Runs body in its own error zone.
scheduleMicrotask(void callback()) → void
Runs a function asynchronously.
unawaited(Future<void>? future) → void
Explicitly ignores a future.
usePathUrlStrategy() → void

Typedefs

action<T> = SaveAction0<T>
action1<T, A> = SaveAction1<T, A>
action2<T, A, B> = SaveAction2<T, A, B>
action3<T, A, B, C> = SaveAction3<T, A, B, C>
action4<T, A, B, C, D> = SaveAction4<T, A, B, C, D>
action5<T, A, B, C, D, E> = SaveAction5<T, A, B, C, D, E>
action6<T, A, B, C, D, E, F> = SaveAction6<T, A, B, C, D, E, F>
ControllerCallback = void Function()
Type of a stream controller's onListen, onPause and onResume callbacks.
ControllerCancelCallback = FutureOr<void> Function()
Type of stream controller onCancel callbacks.
CreatePeriodicTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer))
The type of a custom Zone.createPeriodicTimer implementation function.
CreateTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f())
The type of a custom Zone.createTimer implementation function.
ErrorCallbackHandler = AsyncError? Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace? stackTrace)
The type of a custom Zone.errorCallback implementation function.
ExitCallback = FutureOr<bool> Function(BuildContext context)
Signature for function used in RouteBase.onExit.
ForkHandler = Zone Function(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification? specification, Map<Object?, Object?>? zoneValues)
The type of a custom Zone.fork implementation function.
GoExceptionHandler = void Function(BuildContext context, GoRouterState state, GoRouter router)
The function signature of GoRouter.onException.
GoRouterBuilderWithNav = Widget Function(BuildContext context, Widget child)
Signature of a go router builder function with navigator.
GoRouterPageBuilder = Page Function(BuildContext context, GoRouterState state)
The page builder for GoRoute.
GoRouterRedirect = FutureOr<String?> Function(BuildContext context, GoRouterState state)
The signature of the redirect callback.
GoRouterWidgetBuilder = Widget Function(BuildContext context, GoRouterState state)
The widget builder for GoRoute.
HandleUncaughtErrorHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace)
The type of a custom Zone.handleUncaughtError implementation function.
Signature for functions used to build Navigators
ParserExceptionHandler = RouteMatchList Function(BuildContext context, RouteMatchList routeMatchList)
The function signature of GoRouteInformationParser.onParserException.
PopPageWithRouteMatchCallback = bool Function(Route route, dynamic result, RouteMatchBase match)
Signature for a function that takes in a route to be popped with the result and returns a boolean decision on whether the pop is successful.
PredefinedInputFieldBuilder<T> = T Function({T? initialValue, required String title})
PreviewInputFieldBuilder<T> = Widget Function(BuildContext context, void onChange(T value))
PrintHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, String line)
The type of a custom Zone.print implementation function.
RegisterBinaryCallbackHandler = ZoneBinaryCallback<R, T1, T2> Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2))
The type of a custom Zone.registerBinaryCallback implementation function.
RegisterCallbackHandler = ZoneCallback<R> Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.registerCallback implementation function.
RegisterUnaryCallbackHandler = ZoneUnaryCallback<R, T> Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg))
The type of a custom Zone.registerUnaryCallback implementation function.
RouteMatchVisitor = bool Function(RouteMatchBase)
The function signature for RouteMatchList.visitRouteMatches
RunBinaryHandler = R Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2)
The type of a custom Zone.runBinary implementation function.
RunHandler = R Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.run implementation function.
RunUnaryHandler = R Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg)
The type of a custom Zone.runUnary implementation function.
save<T> = SaveReactiveProvider<T>
Syntactic sugar for SaveReactiveProvider.new
SaveEqConfig = EquatableConfig
SaveEquatable = EquatableMixin
ScheduleMicrotaskHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, void f())
The type of a custom Zone.scheduleMicrotask implementation function.
ShellNavigationContainerBuilder = Widget Function(BuildContext context, StatefulNavigationShell navigationShell, List<Widget> children)
Builder for a custom container for the branch Navigators of a StatefulShellRoute.
ShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, Widget child)
The widget builder for ShellRoute.
ShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, Widget child)
The page builder for ShellRoute.
StatefulShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
The widget builder for StatefulShellRoute.
StatefulShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
The page builder for StatefulShellRoute.
ZoneBinaryCallback<R, T1, T2> = R Function(T1, T2)
ZoneCallback<R> = R Function()
ZoneUnaryCallback<R, T> = R Function(T)

Exceptions / Errors

AccessWhileLoadingError
AsyncError
An error and a stack trace.
DeferredLoadException
Thrown when a deferred library fails to load.
GoError
Thrown when GoRouter is used incorrectly.
GoException
Thrown when GoRouter can not handle a user request.
LoadFailedError
ParallelWaitError<V, E>
Error thrown when waiting for multiple futures, when some have errors.
StateError
TimeoutException
Thrown when a scheduled timeout happens while waiting for an async result.