osam_flutter library

Classes

BinaryReader
The BinaryReader is used to bring data back from the binary format on the disk.
BinaryWriter
The BinaryWriter is used to encode data to the binary format.
Box<E>
Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a separate file in the Hive home directory. [...]
BoxBase<E>
Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a seperate file in the Hive home directory. [...]
BoxEvent
A event representing a change in a box.
Equatable
{@template equatable} A base class to facilitate operator == and hashCode overrides. [...]
EquatableConfig
The default configurion for all Equatable instances. [...]
FadeScaleTransition
A widget that implements the Material fade transition. [...]
FadeScaleTransitionConfiguration
The modal transition configuration for a Material fade transition. [...]
FadeThroughPageTransitionsBuilder
Used by PageTransitionsTheme to define a page route transition animation in which the outgoing page fades out, then the incoming page fades in and scale up. [...]
FadeThroughTransition
Defines a transition in which outgoing elements fade out, then incoming elements fade in and scale up. [...]
HiveAesCipher
Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.
HiveCipher
Abstract cipher can be implemented to customize encryption.
HiveCollection<E extends HiveObject>
List containing HiveObjects.
HiveField
Annotate all fields you want to persist with HiveField.
HiveInterface
The main API interface of Hive. Available through the Hive constant.
HiveList<E extends HiveObject>
Allows defining references to other HiveObjects.
HiveObject
Extend HiveObject to add useful methods to the objects you want to store in Hive
HiveType
Annotate classes with HiveType to generate a TypeAdapter.
IProperty<T>
JustFadeOut
LazyBox<E>
LazyBoxes don't keep the values in memory like normal boxes. Each time a value is read, it is loaded from the backend.
LoadingWrapper
MeasureSize
ModalConfiguration
A configuration object containing the properties needed to implement a modal route. [...]
MultiPresenterProvider
OpenContainer<T extends Object>
A container that grows to fill the screen to reveal new content when tapped. [...]
OsamNavigator<P extends NavigationPresenter>
OsamNotification
OsamProvider
OsamRoute<R>
OsamTabNavigator<P extends TabNavigationPresenter>
PageTransitionSwitcher
A widget that transitions from an old child to a new child whenever child changes using an animation specified by transitionBuilder. [...]
Persist<AS, US>
PersistLifecycleWrapper
Presenter<US, AS>
PresenterProvider<P extends Presenter>
PropertyChanger
PropertyNotifierAdapter
SharedAxisPageTransitionsBuilder
Used by PageTransitionsTheme to define a page route transition animation in which outgoing and incoming elements share a fade transition. [...]
SharedAxisTransition
Defines a transition in which outgoing and incoming elements share a fade transition. [...]
TabNavigation
TabNavigationAdapter
TypeAdapter<T>
Type adapters can be implemented to support non primitive values.
TypeRegistry
TypeRegistries contain the TypeAdapters associated with a typeId. [...]
UseCase
UseCaseContainer
WatchBoxBuilder
A general-purpose widget which rebuilds itself when the box or a specific key change. [...]

Mixins

AfterLayoutMixin<T extends StatefulWidget>
EquatableMixin
A mixin that helps implement equality without needing to explicitly override operator == and hashCode. [...]
LoadingState<W extends StatefulWidget>
TabNavigationPresenter<US, AS>

Extensions

BoxX
Flutter extensions for boxes.
HiveX
Flutter extensions for Hive.
LazyBoxX
Flutter extensions for lazy boxes.
PresenterProviderExtension

Constants

animationThrottle → const Duration
Duration(milliseconds: 100)

Properties

Hive HiveInterface
Global constant to access Hive.
final

Functions

registerOsamAdapters() → void
registerOsamFlutterAdapters() → void
showModal<T>({BuildContext context, ModalConfiguration configuration: const FadeScaleTransitionConfiguration(), bool useRootNavigator: true, WidgetBuilder builder}) Future<T>
Displays a modal above the current contents of the app. [...]
showNotification({Widget child, EdgeInsetsGeometry padding: const EdgeInsets.all(8), Curve curve: Curves.easeIn, Duration animationDuration: const Duration(milliseconds: 300), Duration stayDuration: const Duration(seconds: 1), Duration autoHideDuration: const Duration(seconds: 1), EdgeInsets safeAreaPadding}) → void

Enums

ContainerTransitionType
The OpenContainer widget's fade transition type. [...]
SharedAxisTransitionType
Determines which type of shared axis transition is used.

Typedefs

BoxWidgetBuilder<T>(BuildContext context, Box<T> box) Widget
Signature for a function that builds a widget given a Box.
CloseContainerActionCallback<S>({S returnValue}) → void
Signature for action callback function provided to OpenContainer.openBuilder. [...]
CloseContainerBuilder(BuildContext context, VoidCallback action) Widget
Signature for a function that creates a Widget in closed state within an OpenContainer. [...]
ClosedCallback<S>(S data) → void
Callback function which is called when the OpenContainer is closed.
CompactionStrategy(int entries, int deletedEntries) bool
A function which decides when to compact a box.
KeyComparator(dynamic key1, dynamic key2) int
OnWidgetSizeChange(Size size) → void
OpenContainerBuilder<S>(BuildContext context, CloseContainerActionCallback<S> action) Widget
Signature for a function that creates a Widget in open state within an OpenContainer. [...]
OsamDialog(BuildContext context) Future
PageTransitionSwitcherTransitionBuilder(Widget child, Animation<double> primaryAnimation, Animation<double> secondaryAnimation) Widget
Signature for builders used to generate custom transitions for PageTransitionSwitcher. [...]
SetValue<T>(IProperty<T> notifier, T value) → dynamic
Update<T>(T value) → dynamic

Exceptions / Errors

HiveError
An error related to Hive.
NoRouteException
UseCaseNotFoundException