DartBoardRedux class
DART BOARD REDUX
This documentation is written in a way to be read as reference or as an article, top down. It'll begin discussing the public api and then move deeper into the implementation, keeping code near the discussion.
Summary:
Integrates a Redux Store into your application Provides App Decorations for features to expand Redux capabilities This redux store uses Generic's to allow adapting to multiple features in dart-board.
API:
Functions
T getState
Classes
class FeatureAction
Decorations
ReduxStateDecoration ReduxMiddlewareDecoration
Widget
FeatureStateBuilder
This API should be enough to expose redux functionality to external features.
DartBoardRedux
- Add this to your dependencies:[] and you should be good to go, it's the Feature itself
It provides one app decoration which is the _DartBoardStoreWidget() which manages the store for you.
It uses a global key so we can wire things up internally but kept private so others don't abuse it.
- Inheritance
-
- Object
- DartBoardFeature
- DartBoardRedux
Constructors
- DartBoardRedux({bool includeThunk = true})
Properties
-
appDecorations
→ List<
DartBoardDecoration> -
The app decorations (global)
no setteroverride
-
dependencies
→ List<
DartBoardFeature> -
no setterinherited
- enabled → bool
-
This can be used to allow an extension to exclude itself.
E.g. Based on platform
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implementationName → String
-
no setterinherited
- includeThunk → bool
-
final
- isIntegrationFeature → bool
-
This is a hint if a feature is "Integration" or not.
The only difference here is that "Integration" features
are not displayed in the dependency graph
(to many edges, looks ugly)
no setterinherited
-
methodHandlers
→ Map<
String, MethodCallHandler> -
This map of method handlers can be used to define callbacks
no setterinherited
- namespace → String
-
A namespace to prefix to reference this feature by
Please make it unique
no setteroverride
-
pageDecorationAllowList
→ List<
String> -
Allow list for page decorations in the format
"/route:page_decoration_name"
no setterinherited
-
pageDecorationDenyList
→ List<
String> -
Deny list for page decorations in the format
"/route:page_decoration_name"
no setterinherited
-
pageDecorations
→ List<
DartBoardDecoration> -
The page decorations (page level)
no setterinherited
-
routes
→ List<
RouteDefinition> -
The route definitions
no setterinherited
- 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