masamune library

An application development framework centered on automatic code generation using build_runner.

To use, import package:masamune/masamune.dart.

Classes

AnonymouslyAuthQuery
An AuthQuery for anonymous authentication.
AnonymouslySignInAuthProvider
AuthProvider for performing Authentication.signIn.
Api
Provides static methods for making HTTP requests.
AppBarThemeExtension
Extended theme to extend the AppBar theme.
AppLocalizeBase
Base class for building the localized configuration of the application.
AppPageRoute<T>
Default PageRoute.
AppRef
ScopedValue in the scope of the application.
AppRoute
Automatically generates routing for the entire application.
AppRouter
Controller to define routing for the entire app.
AppRouteScope
InheritedWidget for placing AppRouter on the widget tree.
AppScoped
Place it close to the route (e.g., on top of MaterialApp) to use state management in the app.
AppScopedValueListener
ScopedValueListener that targets the app.
AppScopedValueRef
ScopedValueRef of the application.
AppTheme
Annotation to be given to the theme of the application.
AppThemeData
Set the theme of the application.
AppThemeScope
InheritedWidget for placing AppThemeData on the widget tree.
Asset
A class that provides utilities for handling assets without much awareness of their source location (on the network, on the terminal, in the asset folder).
AssetTextProvider
Provider to load text files from assets and display them in widgets, etc.
AssetThemeData
Defines a list of asset paths.
AssetVideoProvider
Provider to load video files from assets and display them in widgets.
AuthAdapter
Adapters to change the behavior of authentication on different platforms.
AuthAdapterScope
Place it on top of MaterialApp, etc., and set AuthAdapter for the entire app.
AuthDatabase
A database for managing authentication information locally.
Authentication
Authentication implemented by AuthAdapter.
AuthExporter
Import and export DynamicMap data used in AuthDatabase to external files.
AuthProvider
An adapter used to execute various methods of Authentication.
BootRouteQueryBuilder
RouteQueryBuilder for building the boot page (the page that is displayed only when the application is launched).
CardTile
A widget for displaying an image or text over a card widget.
ChangeAuthProvider
AuthProvider for performing Authentication.change.
ChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
ChangeNotifierScopedQuery<Result extends Listenable?>
ChangeNotifierScopedQuery makes it possible to define values globally and manage states individually and safely.
ChangeNotifierScopedQueryFamily<Result extends Listenable?, Param>
You can pass one parameter ChangeNotifierScopedQuery.
ChangePasswordAuthProvider
AuthProvider for performing Authentication.change.
ChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.change.
ChipsInputController<T>
Controller for adding and removing Chip.
CollectionBase<TModel extends DocumentBase>
Define a collection model that includes DocumentBase as an element.
CollectionModelPath
Annotation to create a collection model.
CollectionModelQuery
Query class for defining Model.
ColorThemeData
Define a color scheme.
Completer<T>
A way to produce Future objects and to complete them later with a value or error.
ConfirmChangeAuthProvider
AuthProvider for performing Authentication.confirmChange.
ConfirmChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.confirmChange.
ConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
ConsoleLoggerAdapter
LoggerAdapter for outputting logs to the console.
Controller
Annotation for creating queries for controllers.
ControllerGroup
Annotation to create a query for a group of controllers.
ControllerQueryBase<TController extends ChangeNotifier>
Base class for creating state-to-state usage queries for controllers that are code-generated by the builder.
Credential
Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
DatabaseExporter
Import and export DynamicMap data used in NoSqlDatabase to external files.
DateDuration
A class that represents a date period.
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner.
DocumentBase<T>
Define a document model for storing T types that inherit from ChangeNotifier.
DocumentModelPath
Annotation for creating a documentation model.
DocumentModelQuery
Query class for defining Model.
EmailAndPasswordAuthQuery
An AuthQuery to authenticate by email and password.
EmailAndPasswordChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
EmailAndPasswordChangePasswordAuthProvider
AuthProvider for performing Authentication.change.
EmailAndPasswordReAuthProvider
AuthProvider for performing Authentication.reauth.
EmailAndPasswordRegisterAuthProvider
AuthProvider for performing Authentication.register.
EmailAndPasswordResetAuthProvider
AuthProvider for performing Authentication.reset.
EmailAndPasswordSignInAuthProvider
AuthProvider for performing Authentication.signIn.
EmailAndPasswordVerifyAuthProvider
AuthProvider for performing Authentication.verify.
EmailLinkAuthQuery
An AuthQuery for link authentication via email.
EmailLinkChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
EmailLinkConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
EmailLinkSignInAuthProvider
AuthProvider for performing Authentication.signIn.
EmailLinkVerifyAuthProvider
AuthProvider for performing Authentication.verify.
Empty
Creates a box that will become as small as its parent allows.
FileStorage
Class for using storage functions in local storage.
FontThemeData
Define font themes.
FormAddPageScopedWidget
Abstract class for implementing a new add page for form widgets used for both adding new ones and editing existing ones.
FormAffixStyle
Class for defining prefix and suffix of text form.
FormButton
Create buttons for forms.
FormCheckbox<TValue>
This widget is used to display a check box and save the check or not.
FormChipsField<TValue>
Form to allow text to be entered and saved separately as Chip.
FormController<TValue>
Context for using the form.
FormDateField<TValue>
A form to have the date (month and day) selected.
FormDateFieldPicker
Class that defines a picker style for selecting dates.
FormDateTimeField<TValue>
A form to have the date and time selected.
FormDateTimeFieldDateDelegate
Let the user select only dates FormDateTimeFieldDelegate.
FormDateTimeFieldDateTimeDelegate
Let the date and time be selected together FormDateTimeFieldDelegate.
FormDateTimeFieldDelegate
A delegate where the form picker and formatter are defined.
FormEditPageScopedWidget
Abstract class to implement the existing edit page of a form widget used to both add new and edit existing.
FormEnumField<TEnum extends Enum, TValue>
Form to select from all elements in TEnum.
FormEnumFieldPicker<TEnum extends Enum>
Class that defines the picker style for selecting TEnum.
FormFutureField<T extends Object, TValue>
A form that waits for another process to complete and updates the value of the form based on that value.
FormLabel
Displays the label for each item on the form.
FormMapField<TValue>
Form to select from there with Map as an option.
FormMapFieldPicker
Class that defines the picker style for selection from Map.
FormMedia<TValue>
Form for submitting images and videos. Single media can be submitted.
FormMediaValue
Class for values when handling media in forms.
FormMultiMedia<TValue>
Form for submitting images and videos. Multiple media can be submitted.
FormMultiMediaDelegate
A delegate to determine the design of FormMultiMedia.
FormMultiMediaInlineDelegate
A delegate to build FormMultiMedia with a type design that fits inline with the form.
FormMultiMediaListTileDelegate
A delegate to build a FormMultiMedia with a design of the type arranged in a list.
FormNumField<TValue>
A form to let you select a numerical value.
FormNumFieldPicker
Class that defines a picker style for selecting numbers.
FormRef
A reference scoped to the form passed from FormScopedWidget.build.
FormScopedWidget
Abstract class to implement the View portion of the form widget used to both add new and edit existing forms.
FormStyle
Class for defining styles for Form.
FormTextField<TValue>
Widgets for text fields for forms.
FormValue
Create a query to retrieve form controllers.
Functions
An interface for executing server-side processing.
FunctionsAdapter
An adapter to provide an interface to perform server-side processing.
FunctionsAdapterScope
FunctionsAdapter for the entire app by placing it on top of MaterialApp, etc.
GoogleSpreadSheetLocalize
Annotation for automatic creation of multilingualization codes based on Google spreadsheets.
GradientColor
You can add gradient elements to the theme's color settings.
GridBuilder<T>
Draw a grid list with elements generated from builder given source.
Immutable
Used to annotate a class.
Indent
A widget for setting padding between elements in a Column or ListView.
InitialRouteInformation
Label
Widget for displaying labels used for item titles, etc.
ListBuilder<T>
If source is given, each of its elements is displayed side by side in builder.
ListenableListener<T extends Listenable>
A widget that monitors changes in Listenable and updates the contents of builder when there is a change.
Listenables
Annotation to create a class to put together Listenable.
LoadingBuilder
Pass multiple Future/FutureOr/Null data and display loading or CircularProgressIndicator until all completions are completed.
LocalAuthAdapter
Authentication adapter that stores data on the local terminal.
Locale
An identifier used to select a user's language and formatting preferences.
LocalFile
Class for handling local files and real data.
LocalizationsDelegate<T>
A factory for a set of localized resources of type T, to be loaded by a Localizations widget.
LocalizeScope
Widget to detect localization changes.
LocalLoggerAdapter
Logging can be done locally on the terminal LoggerAdapter.
LocalModelAdapter
A database adapter that stores data on a local terminal.
LocalModelTransactionRef
ModelTransactionRef for LocalModelAdapter. LocalModelAdapter用のModelTransactionRef
LocalStorageAdapter
StorageAdapter for handling files in local storage.
Loggable
Interface for objects that can be passed directly to Logger.send.
Logger
Used for active logging.
LoggerAdapter
Base class for defining platform adapters for storing logs.
LoggerAdapterScope
Place it on top of MaterialApp, etc., and set LoggerAdapter for the entire app.
LoggerDatabase
A simple database for logging information.
LoggerExporter
Import and export DynamicMap data used in LoggerDatabase to external files.
LoggerTrace
LoggerTraceValue
Base class for tracing logs and measuring performance.
LogValue
Class for defining log values for viewing.
MasamuneAdapter
Adapter for easily adding functions to Masamune Framework.
MasamuneAdapterScope<TAdapter extends MasamuneAdapter>
MasamuneAdapter for the entire app by placing it on top of MaterialApp, etc.
MasamuneApp
MaterialApp for Masamune Framework.
MasamuneControllerBase<TValue, TAdapter extends MasamuneAdapter>
Abstract class to inherit when you want to create a controller using MasamuneAdapter.
MemoryStorage
Class for using storage functions on runtime memory.
Provides easy modal functionality.
ModelAdapter
You can implement adapters that define the internal specifications of the model.
ModelAdapterCollectionQuery
Query class to be passed when executing each function of ModelAdapter.
ModelAdapterDocumentQuery
Query class to be passed when executing each function of ModelAdapter.
ModelAdapterScope
Widget for setting ModelAdapter.
ModelCounter
Define the field as a counter.
ModelCounterConverter
ModelFieldValueConverter to enable automatic conversion of ModelCounter as ModelFieldValue.
ModelCounterFilter
Filter class to make ModelCounter available to ModelQuery.filters.
ModelFieldValue<T>
Class for defining special field values.
ModelFieldValueAsMapMixin<T>
Mix-in to allow Json serialization and deserialization of ModelFieldValue.
ModelFieldValueConverter<T extends ModelFieldValue>
Use this when registering special classes in ModelFieldValue.
ModelFieldValueFilter<T extends ModelFieldValue>
Adapter class for determining the behavior of ModelFieldValue in ModelQuery.filters.
ModelQuery
Query class for defining Model.
ModelQueryBase<TModel extends ChangeNotifier>
Base class for creating state-to-state usage queries for the model to be code-generated by the builder.
ModelQueryFilter
Definition class for filtering data.
ModelRefBase<T>
Class for defining relationships between models.
ModelRefBuilder<TSource, TResult>
Builder for granting relationships between models and loading data.
ModelRefBuilderBase<TSource>
Base class for defining ModelRefBuilder.
ModelRefConverter
ModelFieldValueConverter to enable automatic conversion of ModelRefBase as ModelFieldValue.
ModelRefDocumentBase<T>
Define a document base including ModelRefBase and DocumentBase.
ModelRefFilter
Filter class to make ModelRefBase available to ModelQuery.filters.
ModelRefLoaderMixin<T>
It is available by mixing in when using ModelRefBase in DocumentBase.value.
ModelRefMixin<T>
A mix-in to define that it is a relationship between models in DocumentBase, etc.
ModelTimestamp
Define the field as a timestamp.
ModelTimestampConverter
ModelFieldValueConverter to enable automatic conversion of ModelTimestamp as ModelFieldValue.
ModelTimestampFilter
Filter class to make ModelTimestamp available to ModelQuery.filters.
ModelTransactionBuilder<T>
Builder for transactions.
ModelTransactionDocument<T>
Document class for transactions.
ModelTransactionRef
Reference class for performing transactions.
ModelUpdateNotification
This class contains data for change notifications.
NestedAppRouter
Class for creating nested AppRouter.
NestedPage
Pages for use in nested navigators rather than at the top level.
NoSqlDatabase
Class for building a NoSql database model within an application.
OnContext
Object returned when executing on.
OpenAIChatGPTMessage
Message object used in Functions.openAIChatGPT.
PageOrWidgetScopedValueRef
ScopedValueRef of the Page or Widget (whose state can be monitored).
PageParam
Annotation to map each widget parameter to a variable in the page root.
PagePath
Annotation defining the page.
PageRef
A page-scoped reference passed from PageScopedWidget.build.
PageRouteQuery
Annotation to define the RouteQuery of the page.
PageScopedValueListener
ScopedValueListener that targets the page.
PageScopedValueRef
Page's ScopedValueRef.
PageScopedWidget
Abstract class for creating widgets for use on pages.
Prefs
Annotation to define values to be handled in Shared Preferences and to enable type-safe storage and retrieval.
PrefsBase
Base class for creating Prefs classes.
ProgressIndicatorBuilder<T extends Listenable>
Progress indicator to show progress via ChangeNotifier.
QueryParam
Annotation to map each widget parameter to a query parameter in the page path.
ReAuthProvider
AuthProvider for performing Authentication.reauth.
RedirectQuery
Class for defining the page to be displayed in different locations depending on conditions.
Ref
Base class for References passed from ScopedWidget, etc.
RefHasApp
Reference with ScopedValueRef in the application scope.
RefHasPage
Reference with page scope Ref.
RefHasWidget
Reference with widget scope Ref.
RefParam
When specifying a CollectionModelPath or DocumentModelPath field, you can load the referenced document together by specifying it in the field when referencing other documents.
RegisterAuthProvider
AuthProvider for performing Authentication.register.
RemoteFile
Class for handling remote files and real data.
ReorderableListBuilder<T>
You can configure reorderable lists in a similar fashion to ListBuilder.
Required
Used to annotate a named parameter p in a method or function f.
ResetAuthProvider
AuthProvider for performing Authentication.reset.
RouteQuery
Base class for creating queries to perform page transitions.
RouteQueryBuilder
Class for building page queries.
RuntimeAuthAdapter
Authentication adapter using a database that runs only in the app's memory.
RuntimeFunctionsAdapter
FunctionsAdapter] that only returns a normal system without communicating with the server side.
RuntimeLoggerAdapter
Logging in memory LoggerAdapter.
RuntimeModelAdapter
Model adapter that uses a database that runs only in the memory of the application. All data will be reset when the application is re-launched.
RuntimeModelTransactionRef
ModelTransactionRef for RuntimeModelAdapter. RuntimeModelAdapter用のModelTransactionRef
RuntimeStorageAdapter
StorageAdapter for handling files at runtime.
Scoped
Widgets for state management within a page or widget.
ScopedQuery<Result>
ScopedQuery makes it possible to define values globally and manage state individually and safely.
ScopedQueryFamily<Result, Param>
You can pass one parameter ScopedQuery.
ScopedValue<TResult>
Class for extensions to manage state.
ScopedValueContainer
Container object for storing ScopedValue.
ScopedValueListener
An object to monitor ScopedValue in the widget.
ScopedValueRef
Ref] associated with the widget.
ScopedValueState<TResult, TScopedValue extends ScopedValue<TResult>>
State created by ScopedValue.
ScopedWidget
Abstract class for creating widgets that can perform state management under the page.
ScopedWidgetBase
Base class from which widgets can be retrieved with ScopedWidgetScope.of.
ScopedWidgetScope
InheritedWidget for making ScopedWidgetBase retrievable from descendant widgets.
ScrollBuilder
This widget can be placed on top of a ListView or SingleChildScrollView to easily add a RefreshIndicator or Scrollbar.
SearchParam
When specifying each field in CollectionModelPath or DocumentModelPath, you can annotate the field to make it a search target.
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.
SignInAuthProvider
AuthProvider for performing Authentication.signIn.
SmsAuthQuery
An AuthQuery for SMS code authentication.
SmsChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.change.
SmsConfirmChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.confirmChange.
SmsConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
SmsSignInAuthProvider
AuthProvider for performing Authentication.signIn.
SnsSignInAuthProvider
An AuthQuery for OAuth authentication for SNS.
Storage
Provides access to file storage.
StorageAdapter
Adapter for storage functions.
StorageAdapterScope
StorageAdapter for the entire app by placing it on top of MaterialApp, etc.
StorageBase
Abstract class for implementing internal storage functionality.
StorageFile
Abstract class for defining files for storage.
StorageQuery
Query to specify the path of storage on the remote side.
StorageValue
Define storage values.
SuggestionStyle
Class that defines the design for suggestions.
SynchronousFuture<T>
A Future whose then implementation calls the callback immediately.
TextProvider
Provider for loading text data and displaying it in widgets, etc.
TextThemeData
Define a text theme.
TransitionQuery
Route queries for page transitions.
UnknownRouteQueryBuilder
RouteQueryBuilder for building a page (404 page) to display if the page passed to AppRouter is not a hit for the entered path (URL).
UseResult
See useResult for more details.
VerifyAuthProvider
AuthProvider for performing Authentication.verify.
VideoProvider
Provider to load video data and display it in widgets.
WidgetRef
A reference scoped to the widget passed from ScopedWidget.build or Scoped.builder.
WidgetScopedValueRef
Widget's ScopedValueRef.
WidgetThemeData
Defines the theme of the widget.

Enums

AgoraClientRole
Client role used by Agora.io.
AuthLoggerEvent
Authentication events for logging.
FormMediaType
The type of media handled by the form.
ModelFieldValueSource
Defines where the source of the ModelFieldValue is located.
ModelQueryFilterType
Define the filter type for ModelQuery.
ModelUpdateNotificationStatus
Defines the change status of each model.
OpenAIChatGPTModel
Available models of ChatGPT.
OpenAIChatGPTRole
Role of OpenAI messages.
RouteLoggerEvent
Routing events for logging.
ScopedLoggerEvent
Status management events for logging.
ScopedLoggerScope
State management scope for logging.

Mixins

SearchableCollectionMixin<TModel extends SearchableDocumentMixin>
Mix-ins to create collections for which search functions are available.
SearchableDocumentMixin<T>
Mix-in to make documents searchable.

Extensions

BorderRadiusShortenExtensions on num
Extension to allow BorderRadius to be easily described in num.
DateTimeExtensions on DateTime
Provides extended methods for DateTime.
DateTimeIterableExtensions on Iterable<DateTime>
Provides extended methods for DateTime arrays.
DoubleExtensions on double
Provides extended methods for double.
DoubleIterableExtensions on Iterable<double>
Provides extended methods for double arrays.
DurationExtensions on Duration
Provides extended methods for Duration.
DurationShortenExtensions on num
Extension to allow Duration to be easily described in num.
DynamicMapExtensions on Map<String, dynamic>
Provides extended methods for DynamicMap.
DynamicMapModelFieldValueExtensions on DynamicMap
Provides extension methods for DynamicMap for ModelFieldValue.
EdgeInsetsShortenExtensions on num
Extension to allow EdgeInsets to be easily described in num.
FutureIndicatorExtensions on FutureOr<T>
Extension to display Indicator in FutureOr.
InterableOfIterableExtensions on Iterable<Iterable<T>>
Provides extended methods for Iterable arrays.
IntExtensions on int
Provides extended methods for int.
IntIterableExtensions on Iterable<int>
Provides extended methods for int arrays.
IterableExtensions on Iterable<T>
Provides extended methods for T arrays.
JsonDynamicListExtensions on DynamicList
Provides Json extension methods for DynamicList.
JsonDynamicMapExtensions on DynamicMap
Provides Json extension methods for DynamicMap.
ListenableIterableExtensions on Iterable<T>
Provides an extension method for Iterable that includes Listenable as an element.
ListExtensions on List<T>
Provides extended methods for List in T.
MapExtensions on Map<K, V>
Provides extended methods for Map.
MasamuneChangeNotifierScopedValueRefExtensions on RefHasApp
Create an application scope extension method to handle the globally defined ChangeNotifier.
MasamuneControllerAppRefExtensions on AppRef
Create an extension method for AppRef to handle Query for controllers and controller groups.
MasamuneControllerAppScopedValueRefExtensions on AppScopedValueRef
Create extension methods for PageRef and WidgetRef in the Application Scope to handle Query for controllers and controller groups.
MasamuneControllerPageScopedValueRefExtensions on PageScopedValueRef
Create extension methods for PageRef and WidgetRef in Page Scope to handle Query for controllers and controller groups.
MasamuneControllerRefHasAppExtensions on RefHasApp
MasamuneModelAppRefExtensions on AppRef
Create an extension method for AppRef to handle the Query for the model.
MasamuneModelExtensions on RefHasApp
Create extension methods for PageRef and WidgetRef to handle Query for models.
MasamunePrefsExtensions on RefHasApp
Create extension methods for PageRef and WidgetRef to handle Query for prefs.
NullableDoubleExtensions on double?
Provides an extension method for double that is nullable.
NullableIntExtensions on int?
Provides an extension method for int that is nullable.
NullableIterableExtensions on Iterable<T>?
Provides an extension method for Iterable that is nullable.
NullableListExtensions on List<T>?
Provides an extension method for List that is nullable.
NullableMapExtensions on Map<K, V>?
Provides an extension method for Map that is nullable.
NullableNumExtensions on num?
Provides an extension method for num that is nullable.
NullableObjectExtensions on Object?
Provides an extension method for List that is nullable.
NullableSetExtensions on Set<T>?
Provides an extension method for Set that is nullable.
NullableStringExtensions on String?
Provides an extension method for String that is nullable.
NullableValueIterableExtensions on Iterable<T?>
Provides an extension method for Iterable whose value is nullable.
RandomExtensions on Random
Provides extended methods for Random.
RefCacheExtensions on Ref
Provides an extension method for Ref to perform caching.
RefFetchExtensions on Ref
Provides an extension method for Ref to retrieve a ScopedValue that already exists.
RefOnExtensions on PageOrWidgetScopedValueRef
Provides extension methods for PageOrWidgetScopedValueRef for processing in the lifecycle.
RefPeriodicExtensions on PageOrWidgetScopedValueRef
Provides extension methods for PageOrWidgetScopedValueRef to perform periodic processing.
RefQueryExtensions on Ref
Provides an extension method for Ref to manage state using ScopedQuery.
RefRefreshExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to update the widget.
RefWatchExtensions on Ref
Provides an extended method for Ref to monitor ChangeNotifier.
RoutingBuildContedxtExtensions on BuildContext
Provides extension methods for BuildContext.
RoutingNavigatorStateExtensions on NavigatorState
Provides extension methods for NavigatorState.
ScopedWidgetBuildContextExtensions on BuildContext
ScopedWidget related extensions for BuildContext.
SetExtensions on Set<T>
Provides extended methods for Set.
SpaceShortenExtensions on num
Extension to make it easier to describe spaces in num.
StringExtensions on String
Provides extended methods for String.
ThemeBuildContextExtensions on BuildContext
Define a theme extension for BuildContext.
ThemeColorExtensions on Color
Define a theme extension for Color.
ThemeTextStyleExtensions on TextStyle
Define a theme extension for TextStyle.

Constants

appRoute → const AppRoute
Automatically generates routing for the entire application.
appTheme → const AppTheme
Annotation to be given to the theme of the application.
controller → const Controller
Annotation for creating queries for controllers.
controllerGroup → const ControllerGroup
Annotation to create a query for a group of controllers.
formValue → const FormValue
Create a query to retrieve form controllers.
kBlackColor → const Color
Black for design.
kBlackSurfaceColor → const Color
Bright black color for design.
kCardHeight → const double
kDefaultCheckboxBorderWidth → const double
Width of the border outside the default checkbox.
kDefaultLocales → const List<Locale>
Default locale.
kDefaultSearchableFieldKey → const String
Default field key to form a searchable field.
kFormMultiMediaInlineHeight → const double
Default height of the form when using FormMultiMediaInlineDelegate.
kSplashColor → const Color
Splash color.
kTimeFieldKey → const String
Field key to store the document update time.
kTransitionDuration → const Duration
Duration of page transitions.
kTypeFieldKey → const String
Field key to save the type of the special object in the field.
kUidFieldKey → const String
Field key to store the last part of the document path (ddd for aaa/bbb/ccc/ddd).
kWhiteColor → const Color
White for design.
kWhiteSurfaceColor → const Color
Dark white for design.
listenables → const Listenables
Annotation to create a class to put together Listenable.
nestedPage → const NestedPage
Pages for use in nested navigators rather than at the top level.
nullOfBool → const bool?
A null object with a defined type of bool?
nullOfDouble → const double?
A null object with a defined type of double?
nullOfDynamicList → const DynamicList?
A null object with a defined type of DynamicList?
nullOfDynamicMap → const DynamicMap?
A null object with a defined type of DynamicMap?
nullOfInt → const int?
A null object with a defined type of int?
nullOfNum → const num?
A null object with a defined type of num?
nullOfString → const String?
A null object with a defined type of String?
pageParam → const PageParam
Annotation to map each widget parameter to a variable in the page root.
pageRouteQuery → const PageRouteQuery
Annotation to define the RouteQuery of the page.
prefs → const Prefs
Annotation to define values to be handled in Shared Preferences and to enable type-safe storage and retrieval.
queryParam → const QueryParam
Annotation to map each widget parameter to a query parameter in the page path.
refParam → const RefParam
When specifying a CollectionModelPath or DocumentModelPath field, you can load the referenced document together by specifying it in the field when referencing other documents.
searchParam → const SearchParam
When specifying each field in CollectionModelPath or DocumentModelPath, you can annotate the field to make it a search target.
useResult → const UseResult
Used to annotate a method, field, or getter within a class, mixin, or extension, or a or top-level getter, variable or function to indicate that the value obtained by invoking it should be used. A value is considered used if it is assigned to a variable, passed to a function, or used as the target of an invocation, or invoked (if the result is itself a function).
zeroOfNum → const num
A 0 object with a defined type of num?

Properties

sprintf ↔ PrintFormat
getter/setter pair
uuid String
Generate and retrieve the UUID for Version 4.
no setter

Functions

generateCode(int length, {int seed = 0, String charSet = "23456789abcdefghjkmnpqrstuvwxy"}) String
Generates and returns a random string with the number of characters given by length.
initializeDateFormatting([String? locale, String? ignored]) Future<void>
This should be called for at least one locale before any date formatting methods are called. It sets up the lookup for date symbols. Both the locale and ignored parameter are ignored, as the data for all locales is directly available.
jsonDecodeAsList<T extends Object?>(String json, [List<T> defaultValue = const []]) List<T>
Converts json to a Json-decoded List
jsonDecodeAsMap<T extends Object?>(String json, [Map<String, T> defaultValue = const {}]) Map<String, T>
Converts json to a Json-decoded Map<String, dynamic> object.
jsonEncodable(Object? o) bool
If this object is Json encodable, true is returned.
nullOfList<T>() List<T>?
A null object with a defined type of List<T>?
nullOfMap<K, V>() Map<K, V>?
A null object with a defined type of Map<K, V>?
nullOfSet<T>() Set<T>?
A null object with a defined type of Set<T>?
runMasamuneApp(MasamuneApp masamuneApp(List<MasamuneAdapter> adapters), {bool setPathUrlStrategy = true, List<MasamuneAdapter> masamuneAdapters = const []}) Future<void>
Function to apply MasamuneAdapter for Masamune Framework just before runApp, etc.
wait(Iterable futures) Future<void>
Wait until all Futures given in futures are completed.

Typedefs

ApiResponse = Response
An HTTP response where the entire response body is known in advance.
ApiResquest = Request
An HTTP request where the entire request body is known in advance.
ChipBuilder<T> = Widget Function(BuildContext context, ChipsInputController<T> state, T data)
Builder for use with FormChipsField.
DynamicList = List
Represents the type of List<dynamic>.
DynamicMap = Map<String, dynamic>
Represents the type of Map<String, dynamic>.
ListBuilderCallback<T> = List<Widget>? Function(BuildContext context, T item, int index)
Callbacks used by ListBuilder.
ModelRef<T> = ModelRefBase<T>?
Class for defining relationships between models.