core library
Karee lib is a Dart library.
To take full advantage of Karee, you should know what it offers to you.
Karee library is a dart lib very useful to
- Organize your project's files and folders.
- Manage your files and classes names.
- Manage your application navigation with custom constants.
- Manage all your stateless and stateful screens with names.
- Manage all your controllers.
- Organize your application routes with various structures.
Classes
- ErrorContactAddress
- When you are going to release your application, you need to turn your application profile to production and setup the error contact.
- KareeConstants
- Class that defines all managed constants used in karee.
- KareeModuleLoader
- Class used to load a module in the Root application.
- KareeRoutableModule
- Interface implemented by each modules that shares the same Router with the root application.
-
Observer<
T> - Observer
-
Of<
T> - This is a basic implementation of an Observable. This offers a lite observable. An Observer will subscribe to an Observable. Then that observer reacts to whatever item the Observable emits.
- PackageManager
- This class is used to know whether Root is launched as application or module.
Enums
- ApplicationKind
- This enumeration is used to know which kind of application will be ran, MaterialApp or CupertinoApp.
- KareeApplicationType
- KareeApplicationType used to know whether the running instance of Karee's instance is an application or a module.
- KareeErrorCode
- KareeErrorCode is an enumeration that define all keys associated with a specific widget displayed in the Error Screen in dev mode.
- KareeInstanceProfile
- KareeInstanceProfile enumeration used to set the profile of the application.
Properties
-
errorSolution
↔ Map<
KareeErrorCode, Widget Function(BuildContext ct, List env)> -
Map of
KareeErrorCodeas keys anderror screens widget treesas values.getter/setter pair
Functions
-
loadAppConfig(
[String package = '']) → Future< void> - Function used to read application.yaml from resources/config directory.
-
readConfig(
String variable) → dynamic - Function used to read configuration variables from application config in memory.
-
subscribeController(
dynamic controller) → void - subscribeController: Function used by application to subscribe their controllers in core library.
-
subscribeScreen(
Map< Symbol, dynamic> screen) → void - subscribeScreen(): Function used by applications to subscribe their screens in core library.
Exceptions / Errors
- BadUseOfRouterWidgetException
- BadUseOfRouterWidgetException: Exception thrown when a inappropriate RouteMode is used with Internal Routing.
- NoActionFoundError
- NoActionFoundError: Exception thrown when an unknown action is mapped to a route.
- NoRouteFoundError
- NoRouteFoundError: Exception thrown when the application sent an unknown route (path) in KareeRouter.
- NotManageableWidgetException
- NotManagableWidgetException: Exception thrown when the application tries to send in navigation, an unmanagable Screen to the KareeRouter.
- NotRoutableWidgetException
- NotRoutableWidgetException: Exception thrown when trying to inject a non-routable widget during internal routing.