jet_framework
library
Classes
ActiveGuardObserver
Observers the current guards processing navigation event
ActiveNotification
Details of an active notification.
AdaptiveRoute <R >
Builds an AutoRoute instance with RouteType.adaptive type
AdaptiveRouteType
Generates a route transitions based on platform
AggregateValidator <T >
AggregateValidator extends BaseValidator to validate a value using a list of multiple validators.
AlphabeticalValidator
AlphabeticalValidator extends TranslatedValidator to validate if a string contains only alphabetical characters.
AndroidBitmap <T >
Represents a bitmap on Android.
AndroidFlutterLocalNotificationsPlugin
Android implementation of the local notifications plugin.
AndroidInitializationSettings
Plugin initialization settings for Android.
AndroidNotificationAction
Mirrors the Action class in AndroidX.
AndroidNotificationActionInput
Mirrors the RemoteInput functionality available in NotificationCompat.
AndroidNotificationChannel
Settings for Android notification channels.
AndroidNotificationChannelGroup
A group of related Android notification channels.
AndroidNotificationDetails
Contains notification details specific to Android.
AndroidNotificationSound
Represents an Android notification sound.
AnyNotifier <StateT , ValueT > Notifiers
A base class for all "notifiers".
AssetsLinuxIcon
Represents an icon from the Flutter Assets directory.
Currently the assets directory is data/flutter_assets
which is located on the path relative to the executable file.
AssetsLinuxSound
Represents a sound from the Flutter Assets directory.
AsyncData <ValueT > Core
Creates an AsyncValue with a data.
AsyncError <ValueT > Core
Creates an AsyncValue in the error state.
AsyncFormData <Request , Response >
Represents the data state of a form.
AsyncFormError <Request , Response >
Represents the error state of a form.
AsyncFormIdle <Request , Response >
Represents the idle state of a form (initial state, not yet submitted).
AsyncFormLoading <Request , Response >
Represents the loading state of a form.
AsyncFormValue <Request , Response >
A class that represents the state of a form, inspired by AsyncValue from Riverpod.
AsyncLoading <ValueT > Core
Creates an AsyncValue in loading state.
AsyncNotifier <StateT > Notifiers
A Notifier implementation that is asynchronously initialized.
AsyncNotifierProvider <NotifierT extends AsyncNotifier <ValueT > , ValueT > Providers
A provider which creates and listen to an AsyncNotifier .
AsyncResult <ValueT >
A variant of AsyncValue that excludes AsyncLoading .
AsyncValue <ValueT > Core
A utility for safely manipulating asynchronous data.
AuthenticatedState
State when user is authenticated
AuthenticationOptions
Options wrapper for LocalAuthPlatform.authenticate parameters.
AutoLeadingButton
An AutoRoute replacement of appBar aut-leading-button
AutoPageView
Most of the code here is taking from flutter's TabView
AutoPageViewState
State implementation of AutoPageView
AutoRoute
A route entry configuration used in RouteMatcher
to create RouteMatch 's from paths and PageRouteInfo 's
AutoRouteAware
An interface used to mark classes as AutoRouteAware entities
usually implemented by widget States
AutoRouteGuard
A middleware for stacked routes where clients
can either resume or abort the navigation event
AutoRouteGuardCallback
A simple implementation of AutoRouteGuard that
calls the provided OnNavigation function
AutoRouteInformation
An extended type of RouteInformation that holds
an extra property replace which forces the current
route to be replaced
AutoRouteInformationProvider
The route information provider that propagates the platform route information changes.
AutoRouteNavigator
An AutoRoute Wrapper for Navigator
it handles empty stacks and declarative routes
AutoRouteNavigatorState
State of AutoRouteNavigator
AutoRouteObserver
A Navigator observer that notifies AutoRouteAware s of changes to the
state of their Route .
AutoRoutePage <T >
Creates a RoutePage based on routeData.type,
The decision happens inside of onCreateRoute
AutoRouter
A Wrapper for Navigator that handles stack-routing
AutoRouterConfig
Classes annotated with AutoRouteConfig will generate
an abstract class that extends RootStackRouter that
can be extended by the annotated class to be used as the RootRouter of the App
AutoRouterDelegate
An auto_route implementation for RouterDelegate
AutoRouterObserver
An extended version of NavigatorObserver to support
Tab-int and tab-change events observation
AutoRouterState
State implementation of AutoRouter
AutoRouteWrapper
clients will implement this class to provide a wrapped route.
AutoTabsRouter
An implementation of a router widget that handles parallel routeing
AutoTabsRouterState <T extends AutoTabsRouter >
The state implementation of AutoTabsRouter
AutoTabsScaffold
A scaffold wrapper widget that makes creating an AutoTabsRouter
much easier and cleaner
BackgroundTransformer
The default Transformer for Dio .
Base64Validator
Base64Validator extends TranslatedValidator to validate if a string is a valid base64 encoded string.
BaseOptions
A set of base settings for each Dio().
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
BaseValidator <T >
Base class for all validators.
BetweenValidator <T >
BetweenValidator extends TranslatedValidator to validate if a number is within a specified range.
BicValidator
BicValidator extends TranslatedValidator to validate if a string represents a valid BIC (Bank Identifier Code).
BigPictureStyleInformation
Used to pass the content for an Android notification displayed using the
big picture style.
BigTextStyleInformation
Used to pass the content for an Android notification displayed using the
big text style.
BitmapFilePathAndroidIcon
Represents a file path to a bitmap that should be used for as an icon on
Android.
Boot
BypassedState
State when authentication is bypassed (no auth methods available)
ByteArrayAndroidBitmap
Represents a base64 encoded AndroidBitmap.
ByteArrayAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should
be used for as an icon on Android.
ByteDataLinuxIcon
Represents an icon from a raw image data bytes, see LinuxRawIconData .
CancelToken
Controls cancellation of Dio 's requests.
CheckingState
State when checking authentication
CityValidator
CityValidator extends TranslatedValidator to validate if a string represents a valid city name.
ColorCodeValidator
ColorCodeValidator extends TranslatedValidator to validate if a string is a valid color code in specified formats.
ComposeValidator <T >
ComposeValidator extends BaseValidator to validate a value using a list of validators,
returning the first validation error encountered.
ConditionalValidator <T >
ConditionalValidator extends BaseValidator to conditionally validate a value based on a provided condition.
Consumer Core
Build a widget tree while listening to providers.
ConsumerState <WidgetT extends ConsumerStatefulWidget > Core
The State for a ConsumerStatefulWidget .
ConsumerStatefulWidget Core
A StatefulWidget that has a State capable of reading providers.
ConsumerWidget Core
The equivalent of a StatelessWidget that can listen to providers.
ContainsElementValidator <T >
ContainsElementValidator extends TranslatedValidator to validate if a value is
contained within a specified list of values.
ContainsValidator
ContainsValidator extends TranslatedValidator to validate if a string contains a specified substring.
ContentUriAndroidIcon
Represents a content URI that should be used for as an icon on Android.
CountryValidator
CountryValidator extends TranslatedValidator to validate if a string represents a valid country name.
CreditCardCvcValidator
CreditCardCvcValidator extends TranslatedValidator to validate if a string represents a valid credit card CVC (Card Verification Code).
CreditCardExpirationDateValidator
CreditCardExpirationDateValidator extends TranslatedValidator to validate if a string represents a valid credit card expiration date.
CreditCardValidator
CreditCardValidator extends TranslatedValidator to validate if a string represents a valid credit card number.
CupertinoFullscreenDialogTransition
An iOS-style transition used for summoning fullscreen dialogs.
CupertinoPageTransition
Provides an iOS-style page transition animation.
CupertinoRoute <R >
Builds an AutoRoute instance with RouteType.cupertino type
CupertinoRouteType
Generates a route that uses CupertinoRouteTransitionMixin
CustomRoute <R >
Builds an AutoRoute instance with RouteType.custom type
CustomRouteType
Generates a route with user-defined transitions
DarwinInitializationSettings
Plugin initialization settings for Darwin-based operating systems
such as iOS and macOS
DarwinNotificationAction
Describes the notification action itself.
DarwinNotificationAttachment
Represents an attachment for a notification on Darwin-based operation
systems such as iOS and macOS
DarwinNotificationAttachmentThumbnailClippingRect
Represents the clipping rectangle used for the thumbnail image.
DarwinNotificationCategory
Corresponds to the UNNotificationCategory type which is used to configure
notification categories and accompanying options.
DarwinNotificationDetails
Configures notification details specific to Darwin-based operation systems
such as iOS and macOS
DateFutureValidator
DateFutureValidator extends TranslatedValidator to validate if a date string represents a future date.
DatePastValidator
DatePastValidator extends TranslatedValidator to validate if a date string represents a past date.
DateRangeValidator
DateRangeValidator extends TranslatedValidator to validate if a date string falls within a specified date range.
DateTimeValidator
DateTimeValidator extends TranslatedValidator to validate if a value is a valid DateTime object.
DateValidator
DateValidator extends TranslatedValidator to validate if a string can be parsed into a valid DateTime object.
DeepLink
Holds deep-link information
DefaultRouteParser
AutoRoute extension of RouteInformationParser
DefaultStyleInformation
The default Android notification style.
DefaultValueValidator <T >
DefaultValueValidator extends BaseValidator to validate a value using a default value if the value is null.
DeferredLoadingPlaceholder
Displays a progress indicator when the widget is a deferred component
and is currently being installed.
DeferredWidget
Wraps the child inside a deferred module loader.
Dio
Dio enables you to make HTTP requests easily.
DioMixin
DrawableResourceAndroidBitmap
Represents a drawable resource belonging to the Android application that
should be used as a bitmap on Android.
DrawableResourceAndroidIcon
Represents a drawable resource belonging to the Android application that
should be used as an icon on Android.
DunsValidator
DunsValidator extends TranslatedValidator to validate if a string is a valid DUNS number.
EmailValidator
EmailValidator extends TranslatedValidator that validates a given email address.
It uses a regular expression to check if the email address is valid.
EmptyShellRoute
A proxy Route page that provides a way to create a PageRouteInfo
without the need for creating a new Page Widget
EndsWithValidator
EndsWithValidator extends TranslatedValidator to validate if a string ends with a specified suffix.
EqualLengthValidator <T >
EqualLengthValidator extends TranslatedValidator to validate if a value has a specified length.
EqualValidator <T >
EqualValidator extends TranslatedValidator to validate if a value is equal to a specified value.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ErrorState
State when authentication failed with error
EvenNumberValidator
EvenNumberValidator extends TranslatedValidator to validate if a string represents an even number.
FailedState
State when authentication failed (no biometrics available, user cancelled, etc.)
FileExtensionValidator
FileExtensionValidator extends TranslatedValidator to validate if a file path has an allowed extension.
FileNameValidator
FileNameValidator extends TranslatedValidator to validate if a string is a valid file name.
FilePathAndroidBitmap
Represents a file path that should be used for a bitmap on Android.
FilePathLinuxIcon
Represents an icon located at the path in the file system.
It сan be either an absolute UNIX path or a file:// URI scheme, for example:
FileSizeValidator
FileSizeValidator extends TranslatedValidator to validate if a file size string is within a specified maximum size.
FirstNameValidator
FirstNameValidator extends TranslatedValidator to validate if a string represents a valid first name.
FloatValidator <T >
FloatValidator extends TranslatedValidator to validate if a value is a float and does not exceed a maximum value.
FlutterBitmapAssetAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should
be used for as an icon on Android.
FlutterLocalNotificationsPlatform
The interface that all implementations of flutter_local_notifications must
implement.
FlutterLocalNotificationsPlugin
Provides cross-platform functionality for displaying local notifications.
FlutterLocalNotificationsWindows
The Windows implementation of package:flutter_local_notifications.
FontSizeResolvers
FormBuilder
A container for form fields.
FormBuilderCheckbox
Single Checkbox field
FormBuilderCheckboxGroup <T >
A list of Checkboxes for selecting multiple options
FormBuilderChipOption <T >
An option for filter chips.
FormBuilderChoiceChips <T >
A list of Chips that acts like radio buttons
FormBuilderDateRangePicker
Field for selecting a range of dates
FormBuilderDateTimePicker
Field for Date, Time and DateTime input
FormBuilderDropdown <T >
Field for Dropdown button
FormBuilderField <T >
A single form field.
FormBuilderFieldDecoration <T >
Extends FormBuilderField and add a decoration (InputDecoration) property
FormBuilderFieldDecorationState <F extends FormBuilderFieldDecoration <T > , T >
FormBuilderFieldOption <T >
An option for fields with selection options.
FormBuilderFieldState <F extends FormBuilderField <T > , T >
FormBuilderFilterChips <T >
Field with chips that acts like a list checkboxes.
FormBuilderLocalizations
The actual Localizations class is FormBuilderLocalizationsImpl ,
this class exists only for forward compatibility purposes...
FormBuilderLocalizationsDelegate
The actual Localizations class is FormBuilderLocalizationsImpl ,
FormBuilderLocalizationsImpl
Callers can lookup localized strings with an instance of FormBuilderLocalizationsImpl
returned by FormBuilderLocalizationsImpl.of(context).
FormBuilderLocalizationsImplAr
The translations for Arabic (ar).
FormBuilderLocalizationsImplBn
The translations for Bengali Bangla (bn).
FormBuilderLocalizationsImplBs
The translations for Bosnian (bs).
FormBuilderLocalizationsImplCa
The translations for Catalan Valencian (ca).
FormBuilderLocalizationsImplCs
The translations for Czech (cs).
FormBuilderLocalizationsImplDe
The translations for German (de).
FormBuilderLocalizationsImplEn
The translations for English (en).
FormBuilderLocalizationsImplEs
The translations for Spanish Castilian (es).
FormBuilderLocalizationsImplEt
The translations for Estonian (et).
FormBuilderLocalizationsImplFa
The translations for Persian (fa).
FormBuilderLocalizationsImplFr
The translations for French (fr).
FormBuilderLocalizationsImplHr
The translations for Croatian (hr).
FormBuilderLocalizationsImplHu
The translations for Hungarian (hu).
FormBuilderLocalizationsImplId
The translations for Indonesian (id).
FormBuilderLocalizationsImplIt
The translations for Italian (it).
FormBuilderLocalizationsImplJa
The translations for Japanese (ja).
FormBuilderLocalizationsImplKo
The translations for Korean (ko).
FormBuilderLocalizationsImplLo
The translations for Lao (lo).
FormBuilderLocalizationsImplMs
The translations for Malay (ms).
FormBuilderLocalizationsImplNl
The translations for Dutch Flemish (nl).
FormBuilderLocalizationsImplPl
The translations for Polish (pl).
FormBuilderLocalizationsImplPt
The translations for Portuguese (pt).
FormBuilderLocalizationsImplRo
The translations for Romanian Moldavian Moldovan (ro).
FormBuilderLocalizationsImplRu
The translations for Russian (ru).
FormBuilderLocalizationsImplSk
The translations for Slovak (sk).
FormBuilderLocalizationsImplSl
The translations for Slovenian (sl).
FormBuilderLocalizationsImplSw
The translations for Swahili (sw).
FormBuilderLocalizationsImplTh
The translations for Thai (th).
FormBuilderLocalizationsImplTr
The translations for Turkish (tr).
FormBuilderLocalizationsImplUk
The translations for Ukrainian (uk).
FormBuilderLocalizationsImplZh
The translations for Chinese (zh).
FormBuilderLocalizationsImplZhHant
The translations for Chinese, using the Han script (zh_Hant).
FormBuilderRadioGroup <T >
Field to select one value from a list of Radio Widgets
FormBuilderRangeSlider
Field to select a range of values on a Slider
FormBuilderSlider
Field for selection of a numerical value on a slider
FormBuilderState
FormBuilderSwitch
On/Off switch field
FormBuilderTextField
A Material Design text field input.
FormBuilderValidators
Provides utility methods for creating various FormFieldValidator s.
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
FutureProvider <ValueT > Providers
A provider that asynchronously creates a value.
GroupedCheckbox <T >
GroupedRadio <T >
GuardEntry
A class that holds a guard and it's corresponding resolver
Guardo
A widget that provides a biometric authentication gate for your app
GuardoConfig
Configuration options for Guardo authentication
GuardoInherited
InheritedWidget that provides access to GuardoStateNotifier
GuardoService
Service class that handles biometric authentication
GuardoState
Sealed class representing the different authentication states
GuardoStateNotifier
State notifier for managing Guardo authentication state
HasLowercaseCharsValidator
HasLowercaseCharsValidator extends TranslatedValidator to validate if a string
contains a specified minimum number of lowercase characters.
HasNumericCharsValidator
HasNumericCharsValidator extends TranslatedValidator to validate if a string
contains a specified minimum number of numeric characters (digits).
HasSpecialCharsValidator
HasSpecialCharsValidator extends TranslatedValidator to validate if a string
contains a specified minimum number of special characters.
HasUppercaseCharsValidator
HasUppercaseCharsValidator extends TranslatedValidator to validate if a string
contains a specified minimum number of uppercase characters.
The headers class for requests and responses.
HexadecimalValidator
HexadecimalValidator extends TranslatedValidator to validate if a value is a hexadecimal string.
HierarchySegment
An abstract representation of a RouteMatch
HookConsumer
A widget that can both use hooks and listen to providers.
HookConsumerWidget
A widget that can both use hooks and listen to providers.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
IbanValidator
IbanValidator extends TranslatedValidator to validate if a string represents a valid IBAN (International Bank Account Number).
InboxStyleInformation
Used to pass the content for an Android notification displayed using the
inbox style.
InitializationSettings
Settings for initializing the plugin for each platform.
IntegerValidator
IntegerValidator extends TranslatedValidator to validate if a string represents a valid integer.
Interceptor
Interceptor helps to deal with RequestOptions , Response ,
and DioException during the lifecycle of a request
before it reaches users.
Interceptors
A Queue-Model list for Interceptor s.
InterceptorsWrapper
A helper class to create interceptors in ease.
IOSFlutterLocalNotificationsPlugin
iOS implementation of the local notifications plugin.
IpValidator
IpValidator extends TranslatedValidator to validate if a string represents a valid IPv4 or IPv6 address.
IsbnValidator
IsbnValidator extends TranslatedValidator to validate if a string is a valid ISBN (International Standard Book Number).
IsFalseValidator
IsFalseValidator extends TranslatedValidator to validate if a boolean value is false.
IsTrueValidator
IsTrueValidator extends TranslatedValidator to validate if a boolean value is true.
Jet
JetAdapter
JetApiService
Abstract base class for HTTP API interactions
Enhanced with singleton pattern and response model wrapper
Provides a comprehensive networking solution with:
JetBaseErrorHandler
Abstract base class for handling errors in the Jet framework
Provides a contract for implementing custom error handlers
JetBearerTokenInterceptor
JetButton
JetConfig
Configuration class for Jet framework that defines app-wide settings.
JetCupertinoButton
JetDioLoggerConfig
JetError
Represents an error in the Jet framework with comprehensive error information
JetErrorHandler
Default implementation of error handler for the Jet framework
JetFormBuilder <Request , Response >
JetFormNotifier <Request , Response >
JetLocalizations
JetNotifications
Jet Notifications - A comprehensive local notifications system
JetPasswordField
A customizable password field widget with built-in validation and visibility toggle.
JetPhoneField
A customizable phone number field widget with built-in validation.
JetPinField
A customizable PIN field widget with built-in validation using Pinput.
JetStorage
A unified storage solution for the Jet framework that provides both
regular and secure storage capabilities.
JsonValidator
JsonValidator extends TranslatedValidator to validate if a string is a valid JSON format.
KeepAliveTab
A Wrapper widget to utilize AutomaticKeepAliveClientMixin
KeepAliveTabState
The state of KeepAliveTab
LanguageCodeValidator
LanguageCodeValidator extends TranslatedValidator to validate if a string is a valid language code.
LanguageSwitcher
Widget that shows a locale selection bottom sheet
LanguageSwitcherButton
Simple button widget to trigger the locale selector
LastNameValidator
LastNameValidator extends TranslatedValidator to validate if a string represents a valid last name.
LatitudeValidator
LatitudeValidator extends TranslatedValidator to validate if a string represents a valid latitude value.
LicensePlateValidator
LicensePlateValidator extends TranslatedValidator to validate if a string is a valid license plate.
LinuxFlutterLocalNotificationsPlugin
A stub implementation to satisfy compilation of multi-platform packages that
depend on flutter_local_notifications_linux.
This should never actually be created.
LinuxInitializationSettings
Plugin initialization settings for Linux.
LinuxNotificationAction
Represents an action, that send a request message back to the notification
client when invoked. This functionality may not be implemented by the
notification server, conforming clients should check if it's available using
LinuxServerCapabilities .
For more information, please see Desktop Notifications Specification https://specifications.freedesktop.org/notification-spec/latest/ar01s02.html
LinuxNotificationDetails
Configures notification details specific to Linux.
The system may not support all features.
LinuxNotificationIcon
Represents Linux notification icon.
LinuxNotificationLocation
Represents the location on the screen that the notification should point to.
LinuxNotificationSound
Represents Linux notification sound.
LinuxNotificationTimeout
The timeout of the Linux notification.
LinuxRawIconData
Represents an icon in the raw image data.
LinuxServerCapabilities
Represents capabilities, implemented by the Linux notification server.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LockScreen
A simple wrapper widget for lock screen content
LockScreenState
State when showing lock screen
LogInterceptor
LogInterceptor is used to print logs during network requests.
It should be the last interceptor added,
otherwise modifications by following interceptors will not be logged.
This is because the execution of interceptors is in the order of addition.
LogValidator <T >
LogValidator extends TranslatedValidator to log the value being validated.
This validator is primarily used for debugging purposes and always returns null, indicating no validation errors.
LongitudeValidator
LongitudeValidator extends TranslatedValidator to validate if a string represents a valid longitude value.
LowercaseValidator
LowercaseValidator extends TranslatedValidator to validate if a string is entirely lowercase.
MacAddressValidator
MacAddressValidator extends TranslatedValidator to validate if a string represents a valid MAC address.
MacOSFlutterLocalNotificationsPlugin
macOS implementation of the local notifications plugin.
MatchNotValidator
MatchNotValidator extends TranslatedValidator to validate if a string does not match a specified regular expression pattern.
MatchValidator
MatchValidator extends TranslatedValidator to validate if a string matches a specified regular expression pattern.
MaterialRoute
Builds an AutoRoute instance with RouteType.material type
MaterialRouteType
Generates a route that uses MaterialRouteTransitionMixin
MaxLengthValidator <T >
MaxLengthValidator extends TranslatedValidator to validate if a value does not exceed a specified maximum length.
MaxValidator <T >
MaxValidator extends TranslatedValidator to validate if a value is less than or equal to a specified maximum value.
MaxWordsCountValidator
MaxWordsCountValidator extends TranslatedValidator to validate if a string contains no more than a specified number of words.
MediaStyleInformation
Used to pass the content for an Android notification displayed using the
media style.
Message
Represents a message used in Android messaging style notifications.
MessagingStyleInformation
Used to pass the content for an Android notification displayed using the
messaging style.
MimeTypeValidator
MimeTypeValidator extends TranslatedValidator to validate if a string represents a valid MIME type.
MinLengthValidator <T >
MinLengthValidator extends TranslatedValidator to validate if a value meets a specified minimum length.
MinValidator <T >
MinValidator extends TranslatedValidator to validate if a value is greater than or equal to a specified minimum value.
MinWordsCountValidator
MinWordsCountValidator extends TranslatedValidator to validate if a string contains at least a specified number of words.
MsixUtils
Helpful methods to support MSIX and package identity.
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
NamedRoute
A named route that can be used to navigate to a named destination
typically built with NamedRouteDef
NamedRouteDef
Builds an AutoRoute instance with a direct page builder
NavigationFailure
An abstract parent type for all navigation failures
NavigationResolver
Represents a guarded navigation event
which can be either continued or aborted
used in AutoRouteGuard.onNavigation
NegativeNumberValidator <T >
NegativeNumberValidator extends TranslatedValidator to validate if a value is a negative number.
NestedStackRouter
An Implementation of StackRouter used by nested
AutoRouter widgets
NotEqualValidator <T >
NotEqualValidator extends TranslatedValidator to validate if a value is not equal to a specified value.
NotificationAppLaunchDetails
Contains details on the notification that launched the application.
NotificationDetails
Contains notification details specific to each platform.
NotificationResponse
Details of a Notification Action that was triggered.
NotificationsEnabledOptions
Data class that represent current state of notification options.
Notifier <ValueT > Notifiers
A class which exposes a state that can change over time.
NotifierProvider <NotifierT extends Notifier <ValueT > , ValueT > Providers
A provider that exposes a synchronous Notifier .
NotZeroNumberValidator <T >
NotZeroNumberValidator extends TranslatedValidator to validate if a value is not zero.
NumericValidator <T >
NumericValidator extends TranslatedValidator to validate if a value is numeric.
OddNumberValidator
OddNumberValidator extends TranslatedValidator to validate if a string represents an odd number.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
OrValidator <T >
OrValidator extends BaseValidator to validate a value using multiple validators,
returning null if at least one of the validators passes.
PageInfo
Holds information of the generated RoutePage page
PagelessRoutesObserver
This ChangeNotifier observes the top-most entry in Navigator
and reports whether it's a pageless route
Holds information of a named destination
Parameters
This class helps read typed data from
raw maps, it's used for both path-parameters and query-parameters
PassportNumberValidator
PassportNumberValidator extends TranslatedValidator to validate if a string represents a valid passport number.
PasswordValidator
PasswordValidator extends BaseValidator to validate if a string meets specified password requirements.
PathParam
this annotation is used to make parameters that's supposed
to take their values from the dynamic segments of a path
PathValidator
PathValidator extends TranslatedValidator to validate if a string represents a valid file path.
PendingNotificationRequest
Details of a pending notification that has not been delivered.
PendingRoutesHandler
Holds a one-time read initial routes value
used by declarative routing widgets
Person
Details of a person e.g. someone who sent a message.
PhoneNumberValidator
PhoneNumberValidator extends TranslatedValidator to validate if a string represents a valid international phone number.
PhosphorDuotoneIconData
PhosphorFlatIconData
PhosphorIcon
PhosphorIconData
PhosphorIcons
This class helps to access the icons of all the styles. Use the specific style class to access the icons of that style:
PhosphorIconsBold
PhosphorIconsDuotone
PhosphorIconsFill
PhosphorIconsLight
PhosphorIconsRegular
PhosphorIconsThin
PlatformDeepLink
Holds information of the deep-link
coming from the platform window
PortNumberValidator
PortNumberValidator extends TranslatedValidator to validate if a string represents a valid port number.
PositiveNumberValidator <T >
PositiveNumberValidator extends TranslatedValidator to validate if a value is a positive number.
PrimeNumberValidator extends TranslatedValidator to validate if a value is a prime number.
Provider <ValueT > Providers
A provider that exposes a read-only value.
ProviderContainer Core
An object that stores the state of the providers and allows overriding the
behavior of a specific provider.
ProviderObserver Core
An object that listens to the changes of a ProviderContainer .
ProviderObserverContext Core
Information about the ProviderObserver event.
ProviderScope Core
A widget that stores the state of providers.
ProviderSubscription <OutT > Core
Represents the subscription to a ProviderListenable.
QueryParam
this annotation is used to make parameters that's supposed
to take their values from query params of the url
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RangeValidator <T >
RangeValidator extends TranslatedValidator to validate if a value falls within a specified range.
RawResourceAndroidNotificationSound
Represents a raw resource belonging to the Android application that should
be used for the notification sound.
RebuildFactors
REdgeInsets
REdgeInsetsDirectional
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RedirectRoute
Builds a Redirect AutoRoute instance with no type
ReevaluatableRouteMatch <T , R >
When a route is re-evaluated this class is used
to hold currentPage instance which will be used in-case there's no need
to create a new one
ReevaluateListenable
Abstraction for an Adapter that converts
different listenable types e.g (streams) to a ChangeNotifier
Ref Core
An object used by providers to interact with other providers and the life-cycles
of the application.
RejectedByGuardFailure
A failure indicates that the one of the guards
has aborted the navigation on this route
by calling NavigationResolver.next with false value
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after
BaseOptions and Options are composed.
RequiredValidator <T >
RequiredValidator extends TranslatedValidator to validate that a value is required (non-null).
ResolverResult
Holds NavigationResolver.resolveNext values
Response <T >
The Response class contains the payload (could be transformed)
that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
ResponseModel <T >
Response wrapper model for standardized API responses
Inspired by clean architecture patterns for consistent response handling
RootStackRouter
An Implementation of StackRouter used by AutoRouterDelegate
RouteCollection
Holds a single set of config-entries
RouteData <R >
Holds final information of presented routes
That's consumed by AutoRoutePage
RouteDataScope
Injects the given routeData to context
so it can be looked up by any child widget
RouteMatch <T >
This is the result returned by RouteMatcher
when a match is found
RouteNotFoundFailure
A failure indicates that the request route or path
has not been found by the RouteMatcher
RouteOverrides
Holds overridable route values
RoutePage
This annotation is used to mark flutter widgets as routable pages
by enabling the router to construct them.
RouterScope
Injects the given RoutingController to context
so it can be looked up by any child widget
RouteType
An abstraction of route types used by
AutoRoutePage.onCreateRoute to decide transition animations
RoutingController
An Abstraction for an object that manages
page navigation
RPadding
RSizedBox
ScreenUtil
ScreenUtilInit
SingleLineValidator
SingleLineValidator extends TranslatedValidator to validate if a string contains only a single line.
SkipWhenValidator <T >
SkipWhenValidator extends BaseValidator to conditionally skip validation based on a provided condition.
SsnValidator
SsnValidator extends TranslatedValidator to validate if a string represents a valid SSN (Social Security Number).
StackRouter
An implementation of a RoutingController that handles stack navigation
StackRouterScope
Injects the given StackRouter to context
so it can be looked up by any child widget
StartsWithValidator
StartsWithValidator extends TranslatedValidator to validate if a string starts with a specified prefix.
StatefulHookConsumerWidget
A StatefulWidget that is both a ConsumerWidget and a HookWidget.
StateValidator
StateValidator extends TranslatedValidator to validate if a string represents a valid state name.
StreamNotifier <ValueT > Notifiers
A variant of AsyncNotifier which has build creating a Stream .
StreamNotifierProvider <NotifierT extends StreamNotifier <ValueT > , ValueT > Providers
A provider which creates and listen to an StreamNotifier .
StreamProvider <ValueT > Providers
Creates a stream and exposes its latest event.
StreetValidator
StreetValidator extends TranslatedValidator to validate if a string represents a valid street name.
StyleInformation
Abstract class for defining an Android notification style
SyncTransformer
If you want to custom the transformation of request/response data,
you can provide a Transformer by your self, and replace
the transformer by setting the Dio.transformer .
Holds information of Tab-init and Tab-changed events
used in AutoRouteAware and AutoRouterObserver
TabsRouter
An implementation of a RoutingController that handles parallel routeing
TabsRouterScope
Injects the given TabsRouter to context
so it can be looked up by any child widget
TestRoute
Builds a simplified AutoRoute instance for test
ThemeLinuxIcon
Represents a system theme icon.
See https://www.freedesktop.org/wiki/Specifications/icon-naming-spec/ for more help.
ThemeLinuxSound
Represents a system theme sound.
See https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/ for more help.
ThemeSwitcher
ThemeSwitcherNotifier
Theme switcher state notifier
TimeValidator
TimeValidator extends TranslatedValidator to validate if a string represents a valid time in 24-hour or 12-hour format.
TimeZoneValidator
TimeZoneValidator extends TranslatedValidator to validate if a string represents a valid time zone identifier.
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
TransformValidator <T >
TransformValidator extends BaseValidator to transform a value before applying a validator.
TransitionsBuilders
all of the methods in this file map to existing, already-tested flutter widgets
so no-need to include them in test-coverage
a class that holds presets of common route transition builder
TranslatedValidator <T >
Base class for all validators that return a translated error message.
UncontrolledProviderScope Core
Expose a ProviderContainer to the widget tree.
UniqueValidator <T >
UniqueValidator extends TranslatedValidator to validate if a value is unique within a specified list of values.
UppercaseValidator
UppercaseValidator extends TranslatedValidator to validate if a string is entirely uppercase.
UriAndroidNotificationSound
Represents a URI on the Android device that should be used for the
notification sound.
UrlFragment
this annotation is used to mark a parameter as a url fragment
e.g /path#foo
UrlState
UrlState Holds current url state in a more structured way
it's used by Router as configuration state
UrlValidator
UrlValidator extends TranslatedValidator to validate if a string represents a valid URL.
UsernameValidator
UsernameValidator extends TranslatedValidator to validate if a string meets specified username requirements.
UuidValidator
UuidValidator extends TranslatedValidator to validate if a string is a valid UUID (version 4).
VinValidator
VinValidator extends TranslatedValidator to validate if a string is a valid Vehicle Identification Number (VIN).
WidgetRef Core
An object that allows widgets to interact with providers.
WindowsAction
A button in a Windows notification.
WindowsColumn
A vertical column of text and images in a Windows notification.
A header that groups multiple Windows notifications.
WindowsImage
An image in a Windows notification.
WindowsInitializationSettings
Plugin initialization settings for Windows.
WindowsInput
A text or multiple choice input element in a Windows notification.
WindowsNotificationAudio
Specifies custom audio to play during a notification.
WindowsNotificationDetails
Contains notification details specific to Windows.
WindowsNotificationPart
A text or image element in a Windows notification.
WindowsNotificationText
Text in a Windows notification.
WindowsProgressBar
A progress bar in a Windows notification.
WindowsRow
A group of notification content that must be displayed as a whole row.
WindowsSelection
An option that can be selected by a WindowsSelectionInput .
WindowsSelectionInput
A multiple choice input.
WindowsTextInput
A text input.
WrappedRoute <T extends AutoRouteWrapper >
A wrapper widget that's used by the AutoRoutePage to wrap widgets that implement
AutoRouteWrapper
ZipCodeValidator
ZipCodeValidator extends TranslatedValidator to validate if a string represents a valid USA ZIP code.
Functions
bootApplication (JetConfig config , {Future <void > setupFinished (Jet jet → Future <Jet
bootFinished (Jet jet , JetConfig config → Future <Jet
defaultDioExceptionReadableStringBuilder (DioException e → String
The default implementation of building a readable string of DioException .
jetNotification (String title , String body → JetNotifications
Jet notification helper
lookupFormBuilderLocalizationsImpl (Locale locale → FormBuilderLocalizationsImpl
runJetApp ({required Jet jet → Future <void >
showAdaptiveConfirmationDialog ({required BuildContext context , required String title , required String message , required Widget icon , required FutureOr <void > onConfirm (), bool barrierDismissible = true , String ?confirmText , String ?cancelText , bool popOnConfirm = true , VoidCallback ?onCancel → Future <void >
showAdaptiveSimpleDialog ({required BuildContext context , required String title , required String message , String ?doneText , bool popOnDone = true , bool barrierDismissible = true , VoidCallback ?onDone → void
showConfirmationSheet ({required BuildContext context , required String title , required String message , dynamic popOnConfirm = true , ConfirmationSheetType type = ConfirmationSheetType.normal , IconData icon = Icons.info_outline , required FutureOr <void > onConfirm (), VoidCallback ?onCancel , String ?confirmText , String ?cancelText , Axis buttonLayout = Axis.horizontal → void
Typedefs
AnimatedIndexedStackBuilder
= Widget Function(BuildContext context , Widget child
Signature for a wrapper builder used by _AutoTabsRouterIndexedStack
AnimatedIndexedStackTransitionBuilder
= Widget Function(BuildContext context , Widget child , Animation <double animation
Signature for a translation builder used by _AutoTabsRouterIndexedStack
AppBarBuilder
= PreferredSizeWidget Function(BuildContext context , TabsRouter tabsRouter
Signature for a function that takes in BuildContext and TabsRouter
and returns a PreferredSizeWidget usually an AppBar
AutoLeadingButtonBuilder
= Widget Function(BuildContext context , LeadingType leadingType , VoidCallback ?action
Signature function to customize the
build of a leading button
AutoRoutePageBuilder
= Widget Function(RouteData data
A Signature for a function that passes the RouteData and returns a PageRoute
AutoTabsBuilder
= Widget Function(BuildContext context , List <Widget children , TabsRouter tabsRouter
Signature for a wrapper builder used by _AutoTabsRouterBuilder
AutoTabsPageViewBuilder
= Widget Function(BuildContext context , Widget child , PageController pageController
Signature for a wrapper builder used by _AutoTabsRouterPageView
AutoTabsTabBarBuilder
= Widget Function(BuildContext context , Widget child , TabController tabController
Signature for a wrapper builder used by _AutoTabsRouterTabBar
BottomNavigationBuilder
= Widget Function(BuildContext context , TabsRouter tabsRouter
Signature for a function that takes in BuildContext and TabsRouter
and returns a BottomNavigation Widget
CustomRouteBuilder
= Route <T > Function<T >(BuildContext context , Widget child , AutoRoutePage <T > page
Signature for custom router builder used by
CustomRouteType
DeepLinkBuilder
= FutureOr <DeepLink Function(PlatformDeepLink deepLink
Signature for a function that builds DeepLink
deepLink is the pre-resolved link coming from platform window
DeepLinkTransformer
= Future <Uri Function(Uri uri
Signature for a function that transform the incoming Uri
uri is the pre-resolved uri coming from platform window
This is call before the DeepLinkBuilder to allow to transform the Uri
DefaultTransformer SyncTransformer
DeferredWidgetBuilder
= Widget Function()
Signature for a function that returns a widget
Used in DeferredWidget to build the lazy-loaded library
DidReceiveBackgroundNotificationResponseCallback
= void Function(NotificationResponse details
Signature of callback triggered on background isolate when a user taps on a
notification or a notification action.
DidReceiveLocalNotificationCallback
= void Function(int id , String ?title , String ?body , String ?payload
Signature of the callback that is triggered when a notification is shown
whilst the app is in the foreground.
DidReceiveNotificationResponseCallback
= void Function(NotificationResponse details
Signature of callback triggered on main isolate when a user taps on a
notification or a notification action.
DioError DioException
DioError describes the exception info when a request failed.
DioErrorType DioExceptionType
Deprecated in favor of DioExceptionType and will be removed in future major versions.
DioExceptionReadableStringBuilder
= String Function(DioException e
The readable string builder's signature of
DioException.readableStringBuilder .
DioMediaType
The type (alias) for specifying the content-type of the MultipartFile.
FloatingActionButtonBuilder
= Widget ? Function(BuildContext context , TabsRouter tabsRouter
Signature for a function that takes in BuildContext and TabsRouter
and returns a FloatingActionButton Widget or null
FontSizeResolver
= double Function(num fontSize , ScreenUtil instance
FormBuilderFields Map <String FormBuilderFieldState <FormBuilderField dynamic >
A type alias for a map of form fields.
The signature that iterates header fields.
InterceptorErrorCallback
= void Function(DioException error , ErrorInterceptorHandler handler
The signature of Interceptor.onError .
InterceptorSendCallback
= void Function(RequestOptions options , RequestInterceptorHandler handler
The signature of Interceptor.onRequest .
InterceptorSuccessCallback
= void Function(Response response , ResponseInterceptorHandler handler
The signature of Interceptor.onResponse .
JetForm Request , Response >
= JetFormNotifier <Request , Response >
JetFormProvider Request , Response >
= Provider <AsyncFormValue <Request , Response >
JsonDecodeCallback
= FutureOr Function(String
The callback definition for decoding a JSON string.
JsonEncodeCallback
= FutureOr <String Function(Object
The callback definition for encoding a JSON object.
LibraryLoader
= Future <void > Function()
Signature for a function that returns a void future
Used in DeferredWidget to load deferred libraries
LockScreenBuilder
= Widget Function(BuildContext context , VoidCallback onTap
Callback function type for building a custom lock screen widget
NavigatorObserversBuilder
= List <NavigatorObserver Function()
Signature for a builder that returns a list of NavigatorObserver
NullableWidgetBuilder
= Widget Function(BuildContext context , Widget ?leading
Signature function to provide nullable leading widget
based on the current router state
OnGeneratePath
= String Function(AutoRoute route
Signature for a function that generates a path for a route name
OnNavigateCallBack
= void Function(UrlState tree
Signature of a callback used in declarative routing
to report url state changes
OnNavigation
= dynamic Function(NavigationResolver resolver , StackRouter router
Signature for on navigation function used by AutoRouteGuard
OnNavigationChanged
= dynamic Function(TabsRouter tabsRouter
Signature for a callback function used by _AutoTabsRouterBuilder
OnNavigationFailure
= void Function(NavigationFailure failure
Signature for a function that takes a NavigationFailure
Used in RoutingController .
OnNestedNavigateCallBack
= void Function(List <RouteMatch routes
Signature of a callback used by declarative
PageBuilder
= AutoRoutePage Function(RouteData data
Signature for a function uses pagesMap to build an AutoRoutePage
ProgressCallback
= void Function(int count , int total
The type of a progress listening callback when sending or receiving data.
RebuildFactor
= bool Function(MediaQueryData old , MediaQueryData data
RequestEncoder
= FutureOr <List <int Function(String request , RequestOptions options
The type of a request encoding callback.
ResponseDecoder
= FutureOr <String ? Function(List <int responseBytes , RequestOptions options , ResponseBody responseBody
The type of a response decoding callback.
RestorationIdBuilder
= String Function(RouteMatch match
Signature for a function that builds the page restorationId
Used in AutoRoutePage
RouteDataPredicate
= bool Function(RouteData route
Signature of a predicate to select RouteData
RoutePopCallBack
= void Function(RouteMatch route , Page <Object ? page
Signature of a callback to report route pop events
RoutesBuilder
= List <PageRouteInfo <Object ? Function(PendingRoutesHandler handler
Signature of a callback used in declarative routing
ScreenUtilInitBuilder
= Widget Function(BuildContext context , Widget ?child
TitleBuilder
= String Function(BuildContext context , RouteData data
Signature for a function that builds the route title
Used in AutoRoutePage
ValidateStatus
= bool Function(int ?status
The type of a response status code validate callback.
ValueTransformer T >
= dynamic Function(T value
WidgetBuilderWithData
= Widget Function(BuildContext context , RouteData data
Signature for a function that builds a widget with RouteData
