playx
library
Classes
Adapter
Adapters provide a mechanism to drive an animation from an arbitrary source.
For example, synchronizing an animation with a scroll, controlling
an animation with a slider input, or progressing an animation based on
the time of day.
AlignEffect
An effect that animates the target between the specified begin and end
alignments (via Align ).
Defaults to begin=Align.topCenter, end=Align.center.
Allow
Allows the navigation to proceed.
AndroidOptions
Specific options for Android platform.
Animate
The Flutter Animate library makes adding beautiful animated effects to your widgets
simple. It supports both a declarative and chained API. The latter is exposed
via the Widget.animate extension, which simply wraps the widget in Animate.
AnimatedVisibility
Widget that animates the visibility of child widget by updating widget opacity and hide the old widget.
AnimateList <T extends Widget >
Applies animated effects to a list of widgets. It does this by wrapping each
widget in Animate , and then proxying calls to all instances. It can
also offset the timing of each widget's animation via interval.
AnimSearchBar
AppleOptions
Specific options for Apple platform.
AppVersion
Widget to display current App Version.
AreEqual
Match Validator for text fields
checks if the input matches other string
AreNotEqual
AssetLoader
abstract class used to building your Custom AssetLoader
Example:
AssetLottie
AsyncCache <T >
Runs asynchronous functions and caches the result for a period of time.
AsyncMemoizer <T >
A class for running an asynchronous function exactly once and caching its
result.
AutoAnimatedList <T >
Widget that automatically animates list of items when inserting or deleting any item.
BackgroundTransformer
The default Transformer for Dio .
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 .
Bidi
This provides utility methods for working with bidirectional text. All
of the methods are static, and are organized into a class primarily to
group them together for documentation and discoverability.
BidiFormatter
Bidi stands for Bi-directional text. According to
Wikipedia :
Bi-directional text is text containing text in both text directionalities,
both right-to-left (RTL) and left-to-right (LTR). It generally involves text
containing different types of alphabets, but may also refer to
boustrophedon, which is changing text directionality in each row.
Bindings
Bindings should be extended or implemented.
When using GetMaterialApp, all GetPages and navigation
methods (like Get.to()) have a binding property that takes an
instance of Bindings to manage the
dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder <T >
Simplifies Bindings generation from a single callback.
To avoid the creation of a custom Binding instance per route.
BindingWrapper
The methods and properties are modelled after the the real binding class.
Blend
Functions for blending in HCT and CAM16.
Block
Blocks the navigation from proceeding.
BlurBox
BlurEffect
An effect that animates a blur on the target between the
specified begin and end blur radiuses (via ImageFiltered ).
Defaults to begin=0, end=4.
Box
A wrapper around SizedBox to provide static getters for standard spacing.
Use this in Rows, Columns, or standard layouts.
BoxShadowEffect
An effect that animates a BoxShadow between begin and end (via DecoratedBox ).
A value of null for either will be interpreted as a shadow that matches the other shadow but
with a zero offset and blurRadius.
You can also specify a borderRadius that defines rounded corners for the shadow.
Defaults to begin=null, end=BoxShadow(color: Color(0x80000000), blurRadius: 8.0, offset: Offset(0.0, 4.0))
Breadcrumb
Structured data to describe more information prior to the event captured.
See Sentry.captureEvent().
BytesLoader
An interface that can be implemented to support decoding vector graphic
binary assets from different byte sources.
Cache
The cache for decoded SVGs.
CachedNetworkImage
Image widget to show NetworkImage with caching functionality.
CachedNetworkImageProvider
IO implementation of the CachedNetworkImageProvider; the ImageProvider to
load network images using a cache.
CachingExceptionTypeIdentifier
CallbackEffect
An effect that calls a callback function at a particular point in the animation.
It includes a boolean value indicating if the animation is playing in reverse.
Cam16
CAM16, a color appearance model. Colors are not just defined by their hex
code, but rather, a hex code and viewing conditions.
Cancelable <R >
CancelableCompleter <T >
A completer for a CancelableOperation .
CancelableOperation <T >
An asynchronous operation that can be cancelled.
CancelToken
Controls cancellation of Dio 's requests.
CenterLoading
Widget that displays a simple circle loading indicator like in ios.
ChangeNotifierAdapter
Drives an Animate animation from a ChangeNotifier . The valueGetter
should provide a value in the range 0-1 when a change occurs.
ChunkedStreamReader <T >
Utility class for reading elements from a chunked stream .
CircularDottedBorderOptions
Provides options for drawing a dotted border with a circle.
ColorEffect
An effect that animates a Color between begin and end , composited with
the target using blendMode (via ColorFiltered ). A color value of null
will be interpreted as a fully transparent version of the other color.
Defaults to begin=null, end=Color(0x800099FF).
ColorMapper
A class that transforms from one color to another during SVG parsing.
ConnectionStatusController
A controller that monitors the connection status by checking the
device's connectivity. It can also verify internet access through multiple endpoints.
Connectivity
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
ConnectivityPlusLinuxPlugin
The Linux implementation of ConnectivityPlatform.
Contains
checks if the input does contain the provided value;
ContainsAny
check if the value contain at lest one of String form the provided list
Contexts
The context interfaces provide additional context data.
CorePalette
An intermediate concept between the key color for a UI theme, and a full
color scheme. 5 tonal palettes are generated, all except one use the same
hue as the key color, and all vary in chroma.
CrossfadeEffect
An effect that crossfades the incoming child (including preceeding effects)
with a new widget (via Stack and FadeTransition ). It uses a builder so
that the effect can be reused, but note that the builder is only called once
when the effect initially builds.
CupertinoAlertDialogData
CupertinoAppData
CupertinoAppRouterData
CupertinoCheckboxData
CupertinoDatePickerData
CupertinoDialogActionData
CupertinoDialogData
CupertinoElevatedButtonData
CupertinoIconButtonData
CupertinoListTileData
CupertinoModalSheetData
CupertinoNavigationBarData
CupertinoPageData <T >
CupertinoPageScaffoldData
CupertinoProgressIndicatorData
CupertinoRadioData <T >
CupertinoScrollbarData
CupertinoSearchBarData
CupertinoSliderData
CupertinoSliverAppBarData
CupertinoSwitchData
CupertinoTabBarData
CupertinoTabControllerData
CupertinoTabScaffoldData
CupertinoTabViewData
CupertinoTextButtonData
CupertinoTextFieldData
CupertinoTextFormFieldData
CustomEffect
Provide an easy way to add custom animated effects via a builder method that
accepts a BuildContext , target child, and calculated animation value
between begin and end .
CustomInkWell
CustomParameterCodec
annotation to define a custom parameter decoder/encoder
this is useful when the is encoded/decoded in a non-standard way like base64Url
this must be used as an annotation on a field
CustomPathDottedBorderOptions
Provides options for drawing a dotted border with a custom path.
CustomSentryMeasurementUnit
Custom units without builtin conversion. No formatting will be applied to
the measurement value in the Sentry product, and the value with the unit
will be shown as is.
CustomTransition
CustomTransitionPage <T >
Page with custom transition functionality.
DashedLine
Creates a dashed horizontal line widget.
DashedLinePainter
DashedVerticalLinePainter
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive
manner.
DatePickerContentData
DateTimePicker
Utility class for picking date, time, or date and time.
DebugImage
The list of debug images contains all dynamic libraries loaded into
the process and their memory addresses.
Instruction addresses in the Stack Trace are mapped into the list of debug
images in order to retrieve debug files for symbolication.
There are two kinds of debug images:
Native debug images with types macho, elf, and pe
Android debug images with type proguard
more details : https://develop.sentry.dev/sdk/event-payloads/debugmeta/
DebugMeta
The debug meta interface carries debug information for processing errors and crash reports.
DefaultApiError
Default api error model that can be received from network response.
can be updated based on the response.
DefaultAppScrollBehavior
Describes how Scrollable widgets behave for MaterialApp s.
Defaults to use touch, mouse, and trackpad.
DefaultColoredLoggerFormatter
A default logger formatter that uses colored output for log messages.
DefaultColors
DefaultCupertinoDatePicker
DefaultEnglishExceptionMessage
Default client error messages.
To customize your messages you can override ExceptionMessage the same way as this class and customize the messages.
DefaultRetryEvaluator
DefaultSvgTheme
The SVG theme to apply to descendant SvgPicture widgets
which don't have explicit theme values.
DelegatingEventSink <T >
Simple delegating wrapper around an EventSink .
DelegatingFuture <T >
A wrapper that forwards calls to a Future .
DelegatingSink <T >
Simple delegating wrapper around a Sink .
DelegatingStream <T >
Simple delegating wrapper around a Stream .
DelegatingStreamConsumer <T >
Simple delegating wrapper around a StreamConsumer .
DelegatingStreamSink <T >
Simple delegating wrapper around a StreamSink .
DelegatingStreamSubscription <T >
Simple delegating wrapper around a StreamSubscription .
Dio
Dio enables you to make HTTP requests easily.
DioClient
A client for making network requests using Dio.
DioEventProcessor
This is an EventProcessor , which improves crash reports of DioError s.
It adds information about DioError.requestOptions if present and also about
the inner exceptions.
DioForNative
Implements features for Dio on native platforms.
DioMixin
Disposable
If objects that are registered inside GetIt implements Disposable the
onDispose method will be called whenever that Object is unregistered,
reset or its enclosing Scope is popped
DisposableInterface
DottedBorder
A widget that draws a dotted border around its child.
DottedBorderOptions
Provides options for customising the dotted border.
DownloadProgress
Progress of the file that is being downloaded from the originalUrl.
DropShadow
Dsn
The Data Source Name (DSN) tells the SDK where to send the events
DynamicColor
A color that adjusts itself based on UI state provided by DynamicScheme .
DynamicScheme
Constructed by a set of values representing the current UI state (such as
whether or not its dark theme, what the theme style is, etc.), and
provides a set of TonalPalette s that can create colors that fit in
with the theme style. Used by DynamicColor to resolve into a color.
Effect <T >
An empty effect that all other effects extend.
It can be added to Animate , but has no visual effect.
EffectEntry
Because Effect classes are immutable and may be reused between multiple
Animate (or AnimateList ) instances, an EffectEntry is created to store
values that may be different between instances. For example, due to an
interval on AnimateList, or from inheriting timing parameters.
EffectList
Simple helper class to build a list of effects via the chained api.
Example:
ElevationEffect
An effect that animates a Material elevation shadow between begin and end (via PhysicalModel ).
You can also specify a shadow color and borderRadius to add rounded corners.
It defaults to begin=0, end=8.
EndsWith
Equatable
A base class to facilitate operator == and hashCode overrides.
EquatableConfig
The default configuration for all Equatable instances.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ErrorResult
A result representing a thrown error.
EventProcessor
EventProcessor s are callbacks that run for every event. They can either
return a new event which in most cases means just adding data or return
null in case the event will be dropped and not sent.
EventSinkBase <T >
An abstract class that implements EventSink in terms of onAdd ,
onError , and onClose methods.
ExceptionCause
Holds inner exception and stackTrace combinations contained in other exceptions
Extend this abstract class and return inner ExceptionCause of your
exceptions.
ExceptionMessage
Class that can be extended to implement your own custom errors message.
Sentry handles Error.stackTrace by default. For other cases
extend this abstract class and return a custom StackTrace of your
exceptions.
ExceptionTypeIdentifier
An abstract class for identifying the type of Dart errors and exceptions.
FadeEffect
Animates the opacity of the target between the specified
begin and end values (via FadeTransition ).
It defaults to begin=0, end=1.
FadeIndexedStack
Creates an indexed Stack with fade animation.
Creates a Stack widget that paints a single child.
FadeIndexedStackState
FaDuotoneIconData
FaIconData for a font awesome duotone icon.
FaIcon
Creates an Icon Widget that works for non-material Icons, such as the
Font Awesome Icons.
FaIconData
A wrapper for IconData to ensure type safety and correct rendering
with FaIcon .
FastList <T >
FavoriteButton
Creates a button that shows favorite state.
FileLottie
FlexCorePalette
An intermediate concept between the key color for a UI theme, and a full
color scheme. Five tonal palettes are generated, plus a default
error palette if not provided.
FlexTonalPalette
A convenience class for retrieving colors that are constant in hue and
chroma, but vary in tone.
FlexTones
Configuration data class that defines which tone to use from each
FlexTonalPalette when assigning used color to each ColorScheme color.
FlipEffect
An effect that animates a 2.5D card flip rotation effect (via Transform ).
The effect can be horizontal or vertical.
FlutterSecureStorage
A class to manage secure storage in a Flutter application across multiple
platforms.
FlutterSentryAttachment
FollowPathEffect
An effect that moves the target following the specified path (via Transform ).
The path coordinates are relative to the target's nominal position.
FontAwesomeIcons
Icons based on font awesome 7.2.0
FontSizeResolvers
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FrameRate
FullLifeCycleController
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
FutureGroup <T >
A collection of futures waits until all added Future s complete.
Gentle
GetBar
GetBuilder <T extends GetxController >
GetBuilderState <T extends GetxController >
GetConnectInterface
GetCupertinoApp
GetDelegate
GetHttpClient
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get"
class through extensions
GetIt
Very simple and easy to use service locator
You register your object creation factory or an instance of an object with registerFactory ,
registerSingleton or registerLazySingleton
And retrieve the desired object using get or call your locator as function as its a
callable class
Additionally GetIt offers asynchronous creation functions as well as functions to synchronize
the async initialization of multiple Singletons
GetLifeCycle
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares.
The Functions will be called in this order
(( redirect -> onPageCalled -> onBindingsStart ->
onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute <T >
GetNavConfig
This config enables us to navigate directly to a sub-url
GetNavigator
GetNotifier <T >
GetObserver
GetPage <T >
GetPlatform
GetPlatformApp
A widget that represents GetMaterialApp for Android or Material platforms
and GetCupertinoApp for iOS devices or Cupertino platforms.\
GetQueue
GetResponsiveView <T >
Extend this widget to build responsive view.
this widget contains the screen property that have all
information about the screen size and type.
You have two options to build it.
1- with builder method you return the widget to build.
2- with methods desktop, tablet,phone, watch. the specific
method will be built when the screen type matches the method
when the screen is ScreenType.Tablet the tablet method
will be exuded and so on.
Note if you use this method please set the
property alwaysUseBuilder to false
With settings property you can set the width limit for the screen types.
GetResponsiveWidget <T extends GetLifeCycleBase ? >
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetStream <T >
GetStream is the lightest and most performative way of working
with events at Dart. You sintaxe is like StreamController, but it works
with simple callbacks. In this way, every event calls only one function.
There is no buffering, to very low memory consumption.
event add will add a object to stream. addError will add a error
to stream. listen is a very light StreamSubscription interface.
Is possible take the last value with value property.
GetStreamTransformation <T >
GetUtils
GetView <T >
GetView is a great way of quickly access your Controller
without having to call Get.find<AwesomeController>() yourself.
GetWidget <S extends GetLifeCycleBase ? >
GetWidget is a great way of quickly access your individual Controller
without having to call Get.find<AwesomeController>() yourself.
Get save you controller on cache, so, you can to use Get.create() safely
GetWidget is perfect to multiples instance of a same controller. Each
GetWidget will have your own controller, and will be call events as onInit
and onClose when the controller get in/get out on memory.
GetX <T extends DisposableInterface >
GetxController
GetxService
Unlike GetxController, which serves to control events on each of its pages,
GetxService is not automatically disposed (nor can be removed with
Get.delete()).
It is ideal for situations where, once started, that service will
remain in memory, such as Auth control for example. Only way to remove
it is Get.reset().
GetXState <T extends DisposableInterface >
GoRoute Get started
Configuration
Redirection
Transition animations
Named routes
A route that is displayed visually above the matching parent route using the
Navigator .
GoRouteData Type-safe routes
A class to represent a GoRoute in
Type-safe routing .
GoRouteInformationParser
Converts between incoming URLs and a RouteMatchList using RouteMatcher.
GoRouteInformationProvider
The RouteInformationProvider created by go_router.
GoRouter Get started
Upgrading
Configuration
Navigation
Redirection
Web
Deep linking
Named routes
Error handling
State restoration
The route configuration for the app.
GoRouterDelegate
GoRouter implementation of RouterDelegate .
GoRouterState
The route state during routing.
GraphQLResponse <T >
Hct
HCT, hue, chroma, and tone. A color system that provides a perceptually
accurate color measurement system that can also accurately render what
colors will appear as in different lighting environments.
The headers class for requests and responses.
Hint
Hints are used in BeforeSendCallback , BeforeBreadcrumbCallback and
event processors.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
Hub
SDK API contract which combines a client and scope management
HubAdapter
Hub adapter to make Integrations testable
IconViewer
Widget that shows an icon from icon data, svg, image or text.
IdleRecordingSentrySpanV2
Recording span with idle behavior built into the span itself.
IgnoreKeyboardDismiss
Used to ignore keyboard dismiss requests for a specific Widget or Widget
tree.
IgnoreSpanRule
ImageTheme
Widget that is themed by image content by providing image provider.
As it generates color scheme from image content.
ImageViewer
Easily show an image from assets, network, cached network, or svg images.
ImperativeRouteMatch
The route match that represent route pushed through GoRouter.push .
InheritedGoRouter
GoRouter implementation of InheritedWidget.
InitDependency
Data structure used to identify a dependency by type and instanceName
InstanceInfo
Integration <T extends SentryOptions >
Code that provides middlewares, bindings or hooks into certain frameworks or environments,
along with code that inserts those bindings and activates them.
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.
InternalFinalCallback <T >
Special callable class to keep the contract of a regular method, and avoid
overrides if you extend the class that uses it, as Dart has no final
methods.
Used in DisposableInterface to avoid the danger of overriding onStart.
InternetCheckOption
Options for checking the internet connectivity to an address.
InternetCheckResult
Represents the result of an internet connection check.
InternetConnection
A utility class for checking internet connectivity status.
Intl
The Intl class provides a common entry point for internationalization
related tasks. An Intl instance can be created for a particular locale
and used to create a date format via anIntl.date(). Static methods
on this class are also used in message formatting.
IOHttpClientAdapter
The default HttpClientAdapter for native platforms.
IOSinkBase
An abstract class that implements dart:io's IOSink's API in terms of
onAdd , onError , onClose , and onFlush methods.
IOSOptions
Specific options for iOS platform.
Currently there are no specific ios options available, but only shared
options from apple options.
IsArabicNum
checks if the input is a valid integer
IsBool
IsDate
IsDateAfter
IsDateMillis
checks if the input is a valid date to parse by
DateTime.fromMillisecondsSinceEpoch factory
IsEgyptianPhone
IsEmail
checks if the input is a valid email address
IsEmpty
ISentrySpan
Represents performance monitoring Span.
IsFacebookUrl
IsHexColor
checks if the input is valid hex color
IsHindiNum
checks if the input is a valid integer
IsIn
checks if the input is in provided List;
IsInstagramUrl
ISKsaPhone
IsLtrLanguage
IsNotIn
checks if the input is NOT in provided List;
IsNumber
checks if the input is a valid integer
IsolateErrorIntegration
NoOp web integration : isolate doesnt' work in browser
IsOptional
allows you to skip the errors if the input is null
IsPort
checks if the input is a valid port
IsRequired
IsRTLLanguage
IsUrl
IsYoutubeUrl
KeepAliveWrapper
Wrapper for widgets to keep them alive and not destroy them.
KeyboardDismissOnTap
Removes the current focus and hides the keyboard when
the user taps on this widget.
KeyboardVisibilityBuilder
A convenience builder that exposes if the native keyboard is visible.
KeyboardVisibilityController
Provides direct information about keyboard visibility and allows you
to subscribe to changes.
KeyboardVisibilityProvider
Widget that reports to its descendants whether or not
the keyboard is currently visible.
KeyboardVisibilityTesting
LazyStream <T >
A Stream wrapper that forwards to another Stream that's initialized
lazily.
LightSubscription <T >
LinuxOptions
Specific options for Linux platform.
Currently there are no specific linux options available.
ListenEffect
An effect that calls a callback function with its current animation value
between begin and end .
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LoadReleaseIntegration
An Integration that loads the release version from native apps
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.
Lottie
A widget to display a loaded LottieComposition .
The controller property allows to specify a custom AnimationController that
will drive the animation. If controller is null, the animation will play
automatically and the behavior could be adjusted with the properties animate ,
repeat and reverse .
LottieBuilder
A widget that displays a Lottie animation.
LottieCache
LottieComposition
LottieDelegates
LottieDrawable
LottieFontStyle
LottieImageAsset
LottieOptions
LottieProvider
LucideIcons
Lucide Icons
MacOsOptions
Specific options for macOS platform.
Extends AppleOptions and adds the usesDataProtectionKeychain parameter.
MapUtils
Marquee
Match
checks if the input is match other string
MaterialAlertDialogData
MaterialAppBarData
MaterialAppData
MaterialAppRouterData
MaterialCheckboxData
MaterialDatePickerData
MaterialDialogActionData
MaterialDialogData
MaterialDialogFlatActionData
MaterialDynamicColors
Tokens, or named colors, in the Material Design system.
MaterialElevatedButtonData
MaterialIconButtonData
MaterialListTileData
MaterialModalSheetData
MaterialNavBarData
MaterialNavigationBarData
MaterialPageData <T >
MaterialProgressIndicatorData
MaterialRadioData <T >
MaterialScaffoldData
MaterialScrollbarData
MaterialSearchBarData
MaterialSliderData
MaterialSliverAppBarData
MaterialSwitchData
MaterialTabController
MaterialTabControllerData
MaterialTabScaffoldData
MaterialTextButtonData
MaterialTextFieldData
MaterialTextFormFieldData
MaxLength
checks if the input characters length is smaller than the min field
MaxValue
Mechanism
Sentry Exception Mechanism
The exception mechanism is an optional field residing
in the Exception Interface. It carries additional information about
the way the exception was created on the target system.
This includes general exception values obtained from operating system or
runtime APIs, as well as mechanism-specific values.
MemoryLottie
MicroMoney
Used primarily for currency formatting, this number-like class stores
millionths of a currency unit, typically as an Int64.
MiddlewareRunner
MiniStream <T >
MiniSubscription <T >
MinLength
checks if the input characters length is bigger than the min field
MinValue
Mixinable <T >
MixinBuilder <T extends GetxController >
MoveEffect
An effect that moves the target between the specified begin and end
offsets (via Transform.translate ).
Defaults to begin=Offset(0, -16), end=Offset.zero.
transformHitTests is simply passed on to Transform.translate .
MultiImageStreamCompleter
An ImageStreamCompleter with support for loading multiple images.
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
MultiSliver
MultiSliver allows for returning multiple slivers from a single build method
MultiValueListenableBuilder
A widget that rebuilds whenever any of the provided ValueListenable s change.
NetworkError <T >
Generic Wrapper class that represents a failed network response.
NetworkLottie
NetworkResult <T >
Generic Wrapper class for handling network results.
NetworkSuccess <T >
Generic Wrapper class that represents a successful network response.
Node <T >
NoneSentryMeasurementUnit
Untyped value.
NonScrollingWoltModalSheetPage
A NonScrollingWoltModalSheetPage is a specialized page for the WoltModalSheet
that is designed to display content which is flexible in height but unlikely
to require scrolling.
NoOpSentrySpan
NoOpSentrySpanV2
NotContains
checks if input does not contain the provided value;
NotContainsAny
check if the value does not contain any item from the provided list
NoTransitionPage <T >
Custom transition page with no transition.
NullStreamSink <T >
A StreamSink that discards all events.
NumberFormat
Provides the ability to format a number in a locale-specific way.
NumberParserBase <R >
ObjectRegistration <T extends Object >
Obx
The simplest reactive widget in GetX.
ObxState
ObxValue <T extends RxInterface >
Similar to Obx, but manages a local state.
Pass the initial data in constructor.
Useful for simple local states, like toggles, visibility, themes,
button states, etc.
Sample:
ObxValue((data) => Switch(
value: data.value,
onChanged: (flag) => data.value = flag,
),
false.obs,
),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
OnEnterResult
The result of an onEnter callback.
OnErrorIntegration
Integration which captures PlatformDispatcher.onError
See:
OptimizedCard
Optimized Card Widget which provides better shadow effect for the card.
To look more like native card.
OptimizedListTile
OptimizedScrollView
This is an optimized scroll view widget that make it's child scrollable.
It will automatically size itself to fill the space
between the bottom of the last widget and the bottom of the viewport.
OptimizedTextField
A customizable and feature-rich text field with auto-validation support.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
OrientationWidget
OrientationWidget : Widget that can be used to build different widgets for different orientations.
OvalDottedBorderOptions
Provides options for drawing a dotted border with an oval.
PackageInfo
Application metadata. Provides application bundle information on iOS and
application package information on Android.
PackageInfoPlusLinuxPlugin
The Linux implementation of PackageInfoPlatform.
PackageInfoPlusWindowsPlugin
The Windows implementation of PackageInfoPlatform.
PathDecoded
PerformanceCollector
PerformanceContinuousCollector
Used for collecting continuous data about vitals (slow, frozen frames, etc.)
during a transaction/span.
PictureInfo
The decoded result of a vector graphics asset.
PictureProvider
Deprecated class, will be removed, does not do anything.
PlatformAlertDialog
PlatformApp
PlatformAppBar
PlatformCheckbox
PlatformCircularProgressIndicator
PlatformDialogAction
PlatformElevatedButton
PlatformIconButton
PlatformIcons
PlatformListTile
PlatformNavBar
PlatformProvider
A Provider that provides access to the functions of switching platforms.
PlatformProviderState
PlatformRadio <T >
PlatformScaffold
PlatformScrollbar
PlatformSearchBar
PlatformSettingsData
PlatformSlider
PlatformSliverAppBar
PlatformStyleData
PlatformSwitch
PlatformTabController
PlatformTabScaffold
PlatformText
PlatformTextButton
PlatformTextField
PlatformTextFormField
PlatformTheme
PlatformThemeState
PlatformWidget
PlatformWidgetBase <I extends Widget , A extends Widget >
PlatformWidgetBuilder
Provides a builder for either the Material or Cupertino platforms
which take a child for common use
Playx
The Playx library provides a suite of utilities for app setup, configuration, and management.
PlayXAppConfig
PlayXAppConfig: This abstract class is designed to manage the configuration
of your application, including setting up and tearing down any necessary
dependencies. It provides a structured way to initialize and dispose of resources
when your app starts or stops.
PlayxAppSettings
Default application settings for Playx.
PlayxAsyncPrefs
An abstract class that provides an asynchronous interface for accessing
and manipulating SharedPreferences data.
PlayxBaseLogger
Abstract logger interface used by PlayxLogger.
Can be implemented with any backend (e.g., Talker, Logger, etc.).
PlayxBinding
An abstract class for defining bindings associated with routes in the PlayxNavigation system.
PlayxCancelTokenManager
A simple manager that caches and controls CancelToken s via string tags.
This allows grouped request cancellation (e.g., cancelling all API requests
initiated from a specific screen when it is disposed).
PlayxColors
Base class for defining custom colors for each theme.
PlayxCore
Core of the playx_core plugin.
PlayxEnv
Wrapper for configure any the application with global variables using a .env file.
PlayxEnvSettings
Settings for PlayxEnvSettings .
PlayxGetMaterialApp
PlayxGetMaterialApp is a widget that integrates GetMaterialApp with PlayXThemeBuilder and ScreenUtilInit .
PlayxGetNavigationSettings
Default navigation settings for Playx with support for both Navigator and Router.
PlayxGetPlatformApp
PlayxPlatformApp : A widget that wraps GetMaterialApp or GetCupertinoApp based on the platform
with PlayXThemeBuilder to update the app with current theme
and ScreenUtilInit that initializes ScreenUtil
With the ability to set app orientation and more.
PlayxInheritedLocalization
PlayxLocaleConfig
Locale config :
used to configure out app locales by providing the app with the supported locales and localization settings.
Create a class that extends the PlayxLocaleConfig class to implement your own locales.
PlayxLocalization
PlayxLocalization :
Used to update current app locale with id, index, device locale and more.
And holds reference to the current app locale.
With other utilities to be used.
Must be initialized by calling boot before calling any method.
PlayxLocalizationBuilder
PlayxLocalizationBuilder:
It allows us to create a widget with current locale.
It should rebuild the widget automatically after changing the locale.
PlayxLogger
A centralized static logger utility for Playx-based applications.
PlayxLoggerSettings
Settings for initializing a logger without depending on any implementation.
PlayxMaterialApp
PlayxMaterialApp: A custom widget that extends StatelessWidget and wraps
the MaterialApp with additional configurations for theme, screen settings,
and navigation.
PlayxNavigation
An abstract class that provides static methods for navigating within the
application using GoRouter .
PlayxNavigationBuilder
A widget that initializes and manages the PlayxNavigation system.
PlayxNavigationSettings
Default navigation settings for Playx with support for both Navigator and Router.
PlayxNetworkClient
PlayxNetworkClient is a Wrapper around Dio that can perform api request
With better error handling and easily get the result of any api request.
PlayxNetworkClientSettings
This class contains the settings for the PlayxNetworkClient.
You can customize the settings based on your needs.
PlayxNetworkLoggerSettings
Logger settings used to customize what should be logged by the application when performing a request.
PlayxPageConfig
Global configuration for PlayxPage behavior.
PlayxPageConfiguration <T >
Configuration for customizing the behavior, transitions, and appearance
of a custom page route in a Flutter application.
PlayxPlatform
Utility class for determining the current platform type and characteristics.
PlayxPlatformApp
PlayxPlatformApp: A widget that wraps MaterialApp or CupertinoApp based on the platform,
with additional PlayX functionality such as theme management, screen adaptation, and localization.
PlayxPlatformSettings
Platform-specific settings for configuring the appearance and behavior of widgets.
PlayxPrefs
Wrapper for handling shared preferences to save and retrieve data.
PlayxPrefsSettings
PlayxPrefsWithCache
Provides a persistent store for simple data with caching capabilities.
PlayxRoute
A custom route class extending GoRoute that provides additional features
such as custom page transitions, route bindings, and page configuration settings.
PlayxRouter
A class that simplifies navigation using the GoRouter by providing
convenient methods for route management and navigation.
PlayxScreenSettings
Screen Util parameters for configuring screen-related settings in a Flutter application.
PlayxSecurePrefs
Wrapper for handling secure preferences to save and get preferences.
PlayxSecurePrefsSettings
Settings for PlayxSecurePrefsSettings .
PlayxShellBranch
A PlayxShellBranch is a StatefulShellBranch that is used to create a branch with a single route or multiple routes with PlayxRoute s.
PlayxTheme
Manages the app's theme and provides methods to update it.
PlayxThemeAnimation
Base class that defines theme animations and their settings in the Playx theme package.
PlayxThemeBuilder
A widget that provides a way to build a subtree with the current theme.
PlayxThemeClipperAnimation
Defines a clipping-based theme animation using a custom clipper.
PlayxThemeConfig
Theme config :
Used to configure the app's theme by specifying the available themes,
the initial theme index, and whether to save the selected theme to device storage.
PlayxThemeFadeAnimation
Defines a fade animation effect with adjustable opacity levels.
PlayxThemeHorizontalSlideAnimation
Defines a horizontal slide animation effect with adjustable start and end offsets.
PlayxThemeScaleAnimation
Defines a scale animation effect with adjustable scale values.
PlayxThemeSettings
Provides theme-related settings for a Flutter application.
PlayxThemeSwitcher
A StatelessWidget that allows for building widgets based on the current XTheme .
PlayxThemeSwitchingArea
PlayxThemeVerticalSlideAnimation
Defines a vertical slide animation effect with adjustable start and end offsets.
QRule
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RawLottie
A widget that displays a LottieDrawable directly.
ReadMoreText
RebuildFactors
RecordingSentrySpanV2
A span that records timing and attribute data for performance monitoring.
RectDottedBorderOptions
Provides options for drawing a dotted border with a rectangle.
REdgeInsets
REdgeInsetsDirectional
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RegExpRule
allow using a regular expression as validation rule
RelativeGoRouteData Type-safe routes
A class to represent a relative GoRoute in
Type-safe routing .
RenderCache
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.
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.
ResponsiveScreen
ResponsiveScreenSettings
RestartableTimer
A non-periodic timer that can be restarted any number of times.
ResultFuture <T >
A Future wrapper that provides synchronous access to the result of the
wrapped Future once it's completed.
RetryInterceptor
An interceptor that will try to send failed request again
RootBundleAssetLoader
default used is RootBundleAssetLoader which uses flutter's assetloader
RotateEffect
Effect that rotates the target between begin and end (via RotationTransition ).
Values are specified in "turns" (360° or 2𝝅 radians), so a begin=0.25, end=2.25 would start with the child
rotated a quarter turn clockwise (90 degrees), and rotate two full turns (ending at 810 degrees).
Defaults to begin=-1.0, end=0.
RoundedRectDottedBorderOptions
Provides options for drawing a dotted border with a rounded rectangle.
RouteBase
The base class for GoRoute and ShellRoute .
RouteBuilder
Builds the top-level Navigator for GoRouter.
RouteConfiguration
The route configuration for GoRouter configured by the app.
RouteData
Baseclass for supporting
Type-safe routing .
RouteInformationState <T >
The data class to be stored in RouteInformation.state to be used by
GoRouteInformationParser .
RouteMatch
An matched result by matching a GoRoute against a location.
RouteMatchBase
The base class for various route matches.
RouteMatchList
The list of RouteMatchBase objects.
RouteObserverBreadcrumb
This class makes it easier to record breadcrumbs for events of Flutters
NavigationObserver by accepting
RouteSettings .
RouterOutlet <TDelegate extends RouterDelegate <T > , T extends Object >
RouterOutletState <TDelegate extends RouterDelegate <T > , T extends Object >
Routing
RoutingConfig Configuration
A set of parameters that defines routing in GoRouter.
RPadding
RSizedBox
RuntimeChecker
Helper to check in which environment the library is running.
The environment checks (release/debug/profile) are mutually exclusive.
RunZonedGuardedIntegration
Integration that runs runner function within runZonedGuarded and capture
errors on the runZonedGuarded error handler.
See https://api.dart.dev/stable/dart-async/runZonedGuarded.html
Rx <T >
Foundation class used for custom Types outside the common native Dart
types.
For example, any custom "Model" class, like User().obs will use Rx as
wrapper.
RxBool
RxController
RxDouble
RxInt
RxInterface <T >
This class is the foundation for all reactive (Rx) classes that makes Get
so powerful.
This interface is the contract that _RxImpl]<T> uses in all it's
subclass.
RxList <E >
Create a list similar to List<T>
RxMap <K , V >
Rxn <T >
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier <T >
RxnString
Rx class for String Type.
RxNum
RxSet <E >
RxStatus
RxString
Rx class for String Type.
SaturateEffect
An effect that animates the color saturation of the target. The begin and
end values indicate the saturation level, where 0 is fully desaturated
(ie. grayscale) and 1 is normal saturation. Values >1 will oversaturate.
Defaults to begin=0, end=1.
ScaleEffect
An effect that scales the target between the specified begin and end
offset values (via Transform.scale ).
Defaults to begin=Offset(0,0), end=Offset(1,1).
Scheme
This class is the same concept as Flutter's ColorScheme class.
Scope
Scope data to be sent with the event
ScopeObserver
ScreenUtil
ScreenUtilInit
ScrollAdapter
Drives an Animate animation from a ScrollController .
SdkInfo
An object describing the system SDK.
SdkVersion
Describes the SDK that is submitting events to Sentry.
SendPort
Sends messages to its ReceivePort s.
Sentry
Sentry SDK main entry point
SentryApp
App context describes the application.
SentryAssetBundle
An AssetBundle which creates automatic performance traces for loading
assets.
SentryAttachment
Arbitrary content which gets attached to an event.
SentryAttribute
SentryBaggage
SentryBrowser
Carries information about the browser or user agent for web-related errors.
SentryClient
Logs crash reports and events to the Sentry.io service.
SentryCounterMetric
A metric that tracks the number of times an event occurs.
SentryCulture
Culture Context describes certain properties of the culture in which the
software is used.
SentryDevice
This describes the device that caused the event.
SentryDisplay
Represents the current route and allows to report the time to full display.
SentryDisplayWidget
A widget that helps track when its child widget is fully displayed in a Flutter application.
SentryDistributionMetric
A metric that tracks the statistical distribution of a set of values.
SentryEnvelope
Class representation of Envelope file.
SentryEnvelopeItem
Item holding header information and JSON encoded data.
SentryEvent
An event to be reported to Sentry.io.
SentryException
The Exception Interface specifies an exception or error that occurred in a program.
SentryFeatureFlag
SentryFeatureFlags
SentryFeedback
SentryFeedbackForm
A form for submitting user feedback to Sentry.
SentryFlutterOptions
This class adds options which are only available in a Flutter environment.
Note that some of these options require native Sentry integration, which is
not available on all platforms.
SentryGaugeMetric
A metric that tracks a value which can increase or decrease over time.
SentryGeo
Geographical location of the end user or device.
SentryGpu
GPU context describes the GPU of the device.
SentryHttpClient
A http -package compatible HTTP client.
SentryId
Hexadecimal string representing a uuid4 value.
The length is exactly 32
characters. Dashes are not allowed. Has to be lowercase.
SentryLevel
Severity of the logged Event .
SentryLog
SentryLogAttribute
SentryLogger
Interface for emitting custom logs to Sentry.
SentryLoggerFormatter
Interface for formatted logging with template strings.
SentryMask
Wrapping your widget in SentryMask will mask it when capturing replays.
SentryMeasurement
SentryMeasurementUnit
The unit of measurement of a metric value.
Units augment metric values by giving them a magnitude and semantics.
Units and their precisions are uniquely represented by a string identifier.
SentryMessage
The Message Interface carries a log message that describes an event or error.
Optionally, it can carry a format string and structured parameters. This can help to group similar messages into the same issue.
example of a serialized message:
SentryMetric
Base class for metric data points sent to Sentry.
SentryMetrics
Interface for emitting custom metrics to Sentry.
SentryMetricUnit
String constants for metric units.
SentryNavigatorObserver
This is a navigation observer to record navigational breadcrumbs.
For now it only records navigation events and no gestures.
SentryOperatingSystem
Describes the operating system on which the event was created.
SentryOptions
Sentry SDK options
SentryPackage
A SentryPackage part of the SDK.
SentryPrivacyOptions
Configuration of the experimental privacy feature.
SentryProxy
SentryReplayOptions
Configuration of the replay feature.
SentryRequest
The Request interface contains information on a HTTP request related to the event.
In client SDKs, this can be an outgoing request, or the request that rendered the current web page.
On server SDKs, this could be the incoming web request that is being handled.
SentryResponse
The response interface contains information on a HTTP request related to the event.
SentryRuntime
Describes a runtime in more detail.
SentrySamplingContext
Context used by TracesSamplerCallback to determine if transaction
is going to be sampled.
SentryScreenshotWidget
You can add screenshots of child to crash reports by adding this widget.
Ideally you are adding it around your app widget like in the following
example.
SentryScreenshotWidgetStatus
SentrySpan
SentrySpanV2
Represents a basic telemetry span.
SentryStackFrame
Frames belong to a StackTrace
It should contain at least a filename, function or instruction_addr
SentryStackTrace
Stacktrace holds information about the frames of the stack.
SentryStatusCode
SentryThread
The Threads Interface specifies threads that were running at the time an
event happened. These threads can also contain stack traces.
See https://develop.sentry.dev/sdk/event-payloads/threads/
SentryTraceContext
Represents HTTP header "sentry-trace".
SentryTracesSamplingDecision
SentryTransaction
SentryTransactionContext
SentryTransactionInfo
SentryUnmask
Wrapping your widget in SentryUnmask will unmask it when capturing replays.
SentryUser
Describes the current user associated with the application, such as the
currently signed in user.
SentryUserInteractionWidget
Enables the Auto instrumentation for user interaction tracing.
It starts a transaction and finishes after the timeout.
It adds a breadcrumb as well.
SentryViewHierarchy
SentryViewHierarchyElement
SentryWidget
This widget serves as a wrapper to include Sentry widgets such
as SentryScreenshotWidget and SentryUserInteractionWidget .
SentryWidgetsFlutterBinding
ShaderEffect
Effect that applies an animated fragment shader to a target. See
Writing and using fragment shaders
for information on how to include shaders in your app.
ShaderUpdateDetails
Passed to the ShaderEffect.update callback. Contains information necessary
for updating the shader:
ShadowChangeHandlers
If an object implements the ShadowChangeHandler if will get notified if
an Object with the same registration type and name is registered on a
higher scope which will shadow it.
It also will get notified if the shadowing object is removed from GetIt
ShakeEffect
Effect that shakes the target, using translation, rotation, or both (via Transform ).
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing
a persistent store for simple data.
SharedPreferencesAsync
Provides a persistent store for simple data.
SharedPreferencesOptions
Basic options for creating SharedPreferencesAsync classes.
SharedPreferencesWithCache
Provides a persistent store for simple data.
SharedPreferencesWithCacheOptions
Options necessary to create a SharedPreferencesWithCache .
ShellRoute Configuration
A route that displays a UI shell around the matching child route.
ShellRouteBase
Base class for classes that act as shells for sub-routes, such
as ShellRoute and StatefulShellRoute .
ShellRouteContext
Context object used when building the shell and Navigator for a shell route.
ShellRouteData
A class to represent a ShellRoute in
Type-safe routing .
ShellRouteMatch
An matched result by matching a ShellRoute against a location.
ShimmerEffect
An effect that animates gradient overlay effects (via ShaderMask ), such as the shimmer loading effect
popularized by facebook .
SimpleBuilder
SimpleBuilderState
SingleSubscriptionTransformer <S , T >
A transformer that converts a broadcast stream into a single-subscription
stream.
SlideEffect
An effect that moves the target based on a fraction of its size
per the specified begin and end offsets (via SlideTransition ).
Defaults to begin=Offset(0, -0.5), end=Offset.zero
(slide down from half its height).
SliverAnimatedPaintExtent
SliverAnimatedPaintExtent allows for smoothly animating maxPaintExtent changes
SliverAnimatedSwitcher
SliverAnimatedSwitcher sets up an AnimatedSwitcher widget such that
it can be used as a sliver by using SliverStack and SliverFadeTransition
SliverClip
SliverClip clips its sliver child from its paintOrigin to its paintExtent.
Also clips off any overlap if clipOverlap is true
SliverCrossAxisConstrained
Constrains and centers the child sliver to a maximum cross axis extent
specified by maxCrossAxisExtent .
alignment specifies how to align the child where -1 is left +1 is right.
SliverCrossAxisPadded
Constrains and centers the child sliver to a maximum cross axis extent
specified by paddingStart .
SliverPinnedHeader keeps its child pinned to the leading edge of the viewport.
SliverPositioned
A widget that controls where a box child of a SliverStack is positioned.
SliverSizedBox
A custom widget that mimics the behavior of SizedBox but for use inside
a CustomScrollView or other sliver-based lists.
SliverStack
A Stack widget that can be used as a sliver
SliverWoltModalSheetPage
The page classes are responsible for creating a modal sheet page within the context of the
WoltModalSheet . It's designed to represent a visually layered structure with clear
navigation and content display.
SnackbarController
SpanDataConvention
SpanId
The length is exactly 16 characters.
Dashes are not allowed. Has to be lowercase.
SpanStatus
The Span statuses
Spotlight
Spotlight configuration class.
StartsWith
StatefulNavigationShell
Widget for managing the state of a StatefulShellRoute .
StatefulNavigationShellState
State for StatefulNavigationShell.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to
configure StatefulShellRoute .
StatefulShellBranchData
Base class for supporting
StatefulShellRoute
StatefulShellRoute Configuration
A route that displays a UI shell with separate Navigator s for its
sub-routes.
StatefulShellRouteData
Base class for supporting
StatefulShellRoute
StreamCloser <T >
A StreamTransformer that allows the caller to forcibly close the
transformed Stream .
StreamCompleter <T >
A single-subscription stream where the contents are provided later.
StreamGroup <T >
A collection of streams whose events are unified and sent through a central
stream.
StreamQueue <T >
An asynchronous pull-based interface for accessing stream events.
StreamQueueTransaction <T >
A transaction on a StreamQueue , created by StreamQueue.startTransaction .
StreamSinkBase <T >
An abstract class that implements StreamSink in terms of onAdd ,
onError , and onClose methods.
StreamSinkCompleter <T >
A sink where the destination is provided later.
StreamSinkTransformer <S , T >
A StreamSinkTransformer transforms the events being passed to a sink.
StreamSplitter <T >
A class that splits a single source stream into an arbitrary number of
(single-subscription) streams (called "branch") that emit the same events.
StreamZip <T >
A stream that combines the values of other streams.
StrokeText
SubscriptionStream <T >
A Stream adapter for a StreamSubscription .
SuperController <T >
Svg
A utility class for decoding SVG data to a DrawableRoot or a PictureInfo .
SvgAssetLoader
A BytesLoader that decodes and parses an SVG asset in an isolate and
creates a vector_graphics binary representation.
SvgBytesLoader
A BytesLoader that decodes and parses a UTF-8 encoded SVG string from a
Uint8List in an isolate and creates a vector_graphics binary
representation.
SvgCacheKey
A SvgTheme aware cache key.
SvgFileLoader
A BytesLoader that decodes SVG data from a file in an isolate and creates
a vector_graphics binary representation.
SvgImageKey
SvgLoader <T >
A BytesLoader that parses a SVG data in an isolate and creates a
vector_graphics binary representation.
SvgNetworkLoader
A BytesLoader that decodes and parses a UTF-8 encoded SVG string the
network in an isolate and creates a vector_graphics binary representation.
SvgPicture
A widget that will parse SVG data for rendering on screen.
SvgProvider
Rasterizes given svg picture for displaying in Image widget:
SvgStringLoader
A BytesLoader that parses an SVG string in an isolate and creates a
vector_graphics binary representation.
SvgTheme
A theme used when decoding an SVG picture.
SwapEffect
An effect that swaps out the incoming child for a new child at a particular
point in time. This includes all preceding effects. It uses a builder so
that the effect can be reused, but note that the builder is only called once
when the effect initially builds.
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 .
TalkerPlayxLogger
Task <R >
TaskGentle <R >
TaskGentleWithPort <R >
TaskRegular <R >
TaskWithPort <R >
TextValidationRule
interface for the queen validation rules
extend it and implement :
isValid to override the validation logic
translatedError return translated message from nations
nationsKey return key to use with nations
ThemeSwitcherBoxClipper
ThemeSwitcherCircleClipper
ThemeSwitcherClipper
ThemeSwitcherClipperBridge
ThenEffect
A special convenience "effect" that makes it easier to sequence effects after
one another. It does this by establishing a new baseline time equal to the
previous effect's end time and its own optional delay .
All subsequent effect delays are relative to this new baseline.
TimerRefreshWidget
Widget that refreshes it's child on periodic time.
TintEffect
An effect that applies an animated color tint to the target (via ColorFiltered ).
The begin and end values indicate the strength of the tint (0 - 0% tint, 1 - 100% tint).
Defaults to begin=0, end=1.
ToggleEffect
An effect that allows you to toggle the behavior of a builder function at a certain
point in time.
TonalPalette
A convenience class for retrieving colors that are constant in hue and
chroma, but vary in tone.
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
Transport
A transport is in charge of sending the event/envelope either via http
or caching in the disk.
TrustedCertificate
TypeCheckHint
Constants used for Type Check hints.
TypedGoRoute <T extends GoRouteData >
A superclass for each typed go route descendant
TypedQueryParameter <T >
Annotation to override the URI name for a route parameter.
TypedRelativeGoRoute <T extends RelativeGoRouteData >
A superclass for each typed relative go route descendant
TypedRoute <T extends RouteData >
A superclass for each typed route descendant
TypedShellRoute <T extends ShellRouteData >
A superclass for each typed shell route descendant
TypedStatefulShellBranch <T extends StatefulShellBranchData >
A superclass for each typed shell route descendant
TypedStatefulShellRoute <T extends StatefulShellRouteData >
A superclass for each typed shell route descendant
UnsetSentrySpanV2
This class is a marker class to represent unset / not provided span.
Since Dart does not have 'undefined' we use this class to circumvent that issue.
UnsupportedThrowablesHandler
A handler for unsupported throwables used for Expando
Value <T >
ValueAdapter
Drives an Animate animation directly from a value in the range 0-1
ValueBuilder <T >
Manages a local state like ObxValue, but uses a callback instead of
a Rx value.
ValueBuilderState <T >
ValueDelegate <T >
ValueNotifierAdapter
Drives an Animate animation from a ValueNotifier . The value from the
notifier should be in the range 0-1.
ValueResult <T >
A result representing a returned value.
VectorGraphicUtilities
Utility functionality for interaction with vector graphic assets.
VerticalDashedLine
Creates a dashed vertical line widget.
ViewingConditions
In traditional color spaces, a color can be identified solely by the
observer's measurement of the color. Color appearance models such as CAM16
also use information about the environment where the color was
observed, known as the viewing conditions.
VisibilityEffect
An effect that toggles the visibility of the target (via Visibility ).
Defaults to end=true.
WebOptions
Specific options for web platform.
WebUtils
A stubbed version of WebUtils for non-web platforms (e.g. mobile, desktop).
WillSignalReady
If your singleton that you register wants to use the manually signalling
of its ready state, it can implement this interface class instead of using
the signalsReady parameter of the registration functions
(you don't really have to implement much ;-) )
WindowsOptions
Specific options for Windows platform.
WithPort
WoltAlertDialogType
WoltBottomSheetType
A customizable bottom sheet modal that extends WoltModalType .
WoltDialogType
A customizable dialog modal that extends WoltModalType .
WoltModalSheet <T >
WoltModalSheetAnimationStyle
Motion animation styles for both pagination and scrolling within a Wolt Modal Sheet.
WoltModalSheetPage
WoltModalSheetPage is a specialized subclass of SliverWoltModalSheetPage , designed
for scenarios where the main content of a modal sheet is a single non-sliver widget.
This class provides a convenient shortcut for creating a modal sheet page with standard
box widgets, encapsulating them in a sliver-compatible format.
Defines the animation styles for pagination transitions within Wolt Modal Sheet.
WoltModalSheetRoute <T >
WoltModalSheetScrollAnimationStyle
Defines the animation styles for scrolling within Wolt Modal Sheet when the top bar component
of the modal sheet is set to enable becoming visible as the user scrolls.
WoltModalSheetState
WoltModalSheetThemeData
WoltModalType
An abstract base class for creating different types of modals within a UI.
WoltSideSheetType
A customizable side sheet modal that extends WoltModalType .
Worker
Workers
WorkManagerSettings
XDefaultThemeConfig
Default theme configuration.
XLocale
Defines locales with more information like id and name.
These info can be used to change the current locale.
display name of the locale and more.
XTheme
A class that defines the theme settings for the application.
Enums
AccessControlFlag
Keychain access control flags that define security conditions for accessing
items. These flags can be combined to create complex access control
policies.
AndroidBiometricType
Controls which authentication methods are accepted when biometric
authentication is used.
CacheManagerLogLevel
Log levels of the cache manager. Debug shows failed downloads and verbose
also shows successful downloads and cache retrievals.
CenterLoadingType
ConnectionCheckType
The type of connection check to perform.
ConnectionStatus
An enumeration that represents the connection status.
ConnectivityResult
Connection status check result.
DatePickerPlatform
DeviceType
DioExceptionType
The exception enumeration indicates what type of exception
has happened during requests.
Direction
DurationSentryMeasurementUnit
FileAccessMode
The file access mode when downloading a file, corresponds to a subset of
dart:io::FileMode .
FlexPaletteType
Enum used to select tones included in produced FlexTonalPalette.
FlexSchemeVariant
Enum used to return and describe properties of the FlexSchemeVariant
variants to invoke different color scheme generation algorithms
in SeedColorScheme.fromSeeds , when passed to its FlexSchemeVariant
property variant.
FractionSentryMeasurementUnit
InformationSentryMeasurementUnit
InternetStatus
Enum representing the status of internet connectivity.
KeychainAccessibility
KeyChain accessibility attributes as defined here:
https://developer.apple.com/documentation/security/ksecattraccessible?language=objc
KeyCipherAlgorithm
Algorithm used to encrypt/wrap the secret key in Android KeyStore.
ListFormat
Specifies the array format (a single parameter with multiple parameter
or multiple parameters with the same name).
and the separator for array items.
MaxRequestBodySize
Describes the size of http request bodies which should be added to an event
MaxResponseBodySize
Describes the size of http response bodies which should be added to an event
This enum might be removed at any time.
Month
NavigatingType
The type of the navigation.
ObjectRegistrationType
You will see a rather esoteric looking test (const Object() is! T) at several places.
It tests if T is a real type and not Object or dynamic.
For each registered factory/singleton an ObjectRegistration<T> is created
it holds either the instance of a Singleton or/and the creation functions
for creating an instance when get is called
PlatformStyle
PlatformTarget
Extends on TargetPlatform to include web
PlayxPageTransition
Defines various page transition types for routing.
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that
shouldn't be duplicates
ResponseType
Indicates which transformation should be applied to the response data.
RowStyle
ScreenType
SentryLogLevel
SentryMaskingDecision
SentryOrientation
If a device is on portrait or landscape mode
SentryProxyType
SentryReplayQuality
The quality of the captured replay.
SentryScreenshotQuality
The quality of the attached screenshot
SentrySpanStatusV2
SentryTraceLifecycle
Controls how trace data is collected and transmitted to Sentry.
SentryTransactionNameSource
ShaderLayer
SmartManagement
GetX by default disposes unused controllers from memory,
Through different behaviors.
SmartManagement.full
SmartManagement.full is the default one. Dispose classes that are
not being used and were not set to be permanent. In the majority
of the cases you will want to keep this config untouched.
If you new to GetX then don't change this.
SmartManagement.onlyBuilder only controllers started in init:
or loaded into a Binding with Get.lazyPut() will be disposed. If you use
Get.put() or Get.putAsync() or any other approach, SmartManagement
will not have permissions to exclude this dependency. With the default
behavior, even widgets instantiated with "Get.put" will be removed,
unlike SmartManagement.onlyBuilders.
SmartManagement.keepFactory Just like SmartManagement.full,
it will remove it's dependencies when it's not being used anymore.
However, it will keep their factory, which means it will recreate
the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar
SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar
has closed,
SnackbarStatus.OPENING Starts with the opening animation and ends
with the full
snackbar display, SnackbarStatus.CLOSING Starts with the closing animation
and ends
with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
StorageCipherAlgorithm
Algorithm used to encrypt stored data.
SvgSource
An Enum of the possible image path sources.
TextFieldType
Transition
Weekday
WoltModalDismissDirection
The direction in which a WoltModalSheet can be dismissed when drag to dismiss is enabled.
WorkPriority
Functions
ambiguate <T > (T? value → T?
asBool (dynamic json , String key → bool
Returns a bool for the value at key.
Throws a FormatException if the value cannot be converted.
asBoolOr (dynamic json , String key , {bool fallback = false → bool
Returns a bool for the value at key, or fallback if conversion fails.
asBoolOrNull (dynamic json , String key → bool ?
====================
bool conversions
asDateTime (dynamic json , String key → DateTime
Returns a DateTime for the value at key.
Throws a FormatException if the value cannot be parsed.
asDateTimeOr (dynamic json , String key , {required DateTime fallback → DateTime
Returns a DateTime for the value at key, or fallback if parsing fails.
asDateTimeOrNull (dynamic json , String key → DateTime ?
====================
DateTime conversions
asDouble (dynamic json , String key → double
Returns a double for the value at key.
Throws a FormatException if the value cannot be converted.
asDoubleOr (dynamic json , String key , {double fallback = 0.0 → double
Returns a double for the value at key, or fallback if conversion fails.
asDoubleOrNull (dynamic json , String key → double ?
====================
double conversions
asEnum <T extends Enum > (dynamic json , String key , List <T > values → T
Returns an enum for the value at key.
Throws a FormatException if the value cannot be matched.
asEnumOr <T extends Enum > (dynamic json , String key , List <T > values , {required T fallback → T
Returns an enum for the value at key, or fallback if parsing fails.
asEnumOrNull <T extends Enum > (dynamic json , String key , List <T > values → T?
====================
Enum conversions
asInt (dynamic json , String key → int
Returns an int for the value at key.
Throws a FormatException if the value cannot be converted.
asIntOr (dynamic json , String key , {int fallback = 0 → int
Returns an int for the value at key, or fallback if conversion fails.
asIntOrNull (dynamic json , String key → int ?
====================
int conversions
asList <T > (dynamic json , String key , {T fromJson (dynamic json → List <T >
Converts the value at key to a List.
asListInt (dynamic json , String key , {int fromJson (dynamic json → List <int
Returns a Listint for the value at key.
Throws a FormatException if the value is not a list of ints.
asListIntOr (dynamic json , String key , {List <int fallback = const [] , int fromJson (dynamic json → List <int
Returns a Listint for the value at key, or fallback if conversion fails.
asListIntOrNull (dynamic json , String key , {int fromJson (dynamic json → List <int ?
====================
Listint conversions
asListOr <T > (dynamic json , String key , {List <T > fallback = const [] , T fromJson (dynamic json → List <T >
Converts the value at key to a List.
asListOrNull <T > (dynamic json , String key , {T fromJson (dynamic json → List <T > ?
====================
List conversions (generic)
asListString (dynamic json , String key , {String fromJson (dynamic json → List <String
Returns a List for the value at key.
Throws a FormatException if the value is not a list of strings.
asListStringOr (dynamic json , String key , {List <String fallback = const [] , String fromJson (dynamic json → List <String
Returns a List for the value at key, or fallback if conversion fails.
asListStringOrNull (dynamic json , String key , {String fromJson (dynamic json → List <String ?
====================
ListString conversions
asLocalDateTime (dynamic json , String key → DateTime
Returns a local DateTime for the value at key.
Throws a FormatException if the value cannot be parsed.
asLocalDateTimeOr (dynamic json , String key , {required DateTime fallback → DateTime
Returns a local DateTime for the value at key, or fallback if parsing fails.
asLocalDateTimeOrNull (dynamic json , String key → DateTime ?
Returns a local DateTime with current timezone if the value at key can be parsed, otherwise null.
asMap <T , S > (dynamic json , String key → Map <T , S >
Returns a Map for the value at key.
Throws a FormatException if the value is not a map.
asMapOr <T , S > (dynamic json , String key , {Map <T , S > fallback = const {} → Map <T , S >
Returns a Map for the value at key, or fallback if conversion fails.
asMapOrNull <T , S > (dynamic json , String key → Map <T , S > ?
====================
Map conversions
asNum (dynamic json , String key → num
Returns a num (int or double) for the value at key.
Throws a FormatException if the value cannot be converted.
asNumOr (dynamic json , String key , {num fallback = 0 → num
Returns a num (int or double) for the value at key, or fallback if conversion fails.
asNumOrNull (dynamic json , String key → num ?
====================
num conversions
asString (dynamic json , String key → String
Returns a String for the value at key.
Throws a FormatException if the value cannot be converted.
asStringOr (dynamic json , String key , {String fallback = '' → String
Returns a String for the value at key, or fallback if conversion fails.
asStringOrNull (dynamic json , String key → String ?
====================
String conversions
asT <T > (dynamic json , String key , {T fromJson (dynamic json → T
asTOr <T > (dynamic json , String key , {T fromJson (dynamic json required T fallback → T
asTOrNull <T > (dynamic json , String key , {T fromJson (dynamic json → T?
====================
Generic conversion
asUri (dynamic json , String key → Uri
Returns an Uri for the value at key.
Throws a FormatException if the value cannot be parsed.
asUriOr (dynamic json , String key , {required Uri fallback → Uri
Returns an Uri for the value at key, or fallback if parsing fails.
asUriOrNull (dynamic json , String key → Uri ?
====================
Uri conversions
bodyBytesToString (Stream <List <int bodyBytes , Map <String String headers → Future <String
clearClipboard ()
→ Future <void >
Clear the clipboard.
collectBytes (Stream <List <int source → Future <Uint8List
Collects an asynchronous sequence of byte lists into a single list of bytes.
collectBytesCancelable (Stream <List <int source → CancelableOperation <Uint8List
Collects an asynchronous sequence of byte lists into a single list of bytes.
containsAny (String v , List <String list , {bool caseSensitive = false , bool trim = true → bool
containsTargetOrMatchesRegExp (List <String tracePropagationTargets , String url → bool
copyToClipboard (String text → Future <void >
Copies text to clipboard.
debounce <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration ?time , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
debounce is similar to interval , but sends the last value.
Useful for Anti DDos, every time the user stops typing for 1 second,
for instance.
When listener emits the last "value", when time hits,
it calls callback with the last "value" emitted.
defaultDioExceptionReadableStringBuilder (DioException e → String
The default implementation of building a readable string of DioException .
defaultLogWriterCallback (String value , {bool isError = false → void
default logger from GetX
enterFullScreen ()
→ void
Enables full-screen immersive mode (hides status and navigation bars).
ever <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Called every time listener changes. As long as the condition
returns true.
everAll (List <RxInterface listeners , WorkerCallback callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Similar to ever , but takes a list of listeners, the condition
for the callback is common to all listeners,
and the callback is executed to each one of them. The Worker is
common to all, so worker.dispose() will cancel all streams.
exitFullScreen ()
→ void
Exits full-screen and restores system overlays (status and navigation bars).
formatData (BuildContext context , String data → String
getBlendedColorScheme (ColorScheme firstColorScheme , ColorScheme secondColorScheme → ColorScheme
getClipboardText ()
→ Future <String ?
Retrieves text from clipboard.
hideKeyboard ()
→ void
Hides the on-screen keyboard, if visible.
interval <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration time = const Duration(seconds: 1) , dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
Ignore all changes in listener during time (1 sec by default) or until
condition is met (can be a bool expression or a bool Function()),
It brings the 1st "value" since the period of time, so
if you click a counter button 3 times in 1 sec, it will show you "1"
(after 1 sec of the first press)
click counter 3 times in 1 sec, it will show you "4" (after 1 sec)
click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
isArabicNum (String input → bool
isBool (Object ?input → bool
isCupertino (BuildContext context → bool
isDate (String ?v → bool
checks if the input is a valid date to parse by Dart DateTime class
isDateAfter (Object ?input , DateTime date → bool
isDateMills (String v , {bool isUtc = false → bool
checks if the input is a valid date to parse by DateTime.fromMillisecondsSinceEpoch factory
isEgyptianNumber (String str → bool
isEmail (String ?email → bool
checks if the value can be well formatted email address
isEmpty (String ?input → bool
trim the string then checks if isEmpty
if string is empty it will returns true
isFacebookUrlValid (String url → bool
isHexColor (String ?input → bool
can starts with or without#
must contains
isHindiNum (String input → bool
isIn (Object v , List <Object list → bool
check if string is in List<String>
isInstgramUrlValid (String url → bool
isKsaPhone (String input → bool
isLtrLanguage (String languageCode → bool
isMaterial (BuildContext context → bool
isNotEmpty (String ?string → bool
trim the string then checks if isNotEmpty
isNotIn (Object v , List <Object list → bool
check if value is NOT in List
isNumber (String ?input → bool
isPort (Object ?input → bool
isRetryable (int statusCode → bool
Be careful: this method do not
take into account RetryInterceptor.retryableExtraStatuses
isRtlLanguage (String languageCode → bool
isUrlValid (String url → bool
isValidSampleRand (double ?sampleRand → bool
isValidSampleRate (double ?sampleRate → bool
isYoutubeUrLValid (String url → bool
match (Object ?input , Object ?other → bool
checks if two Strings are the same
maxValue (Object ?value , num max → bool
minLength (String ?input , int min → bool
minValue (Object ?value , num min → bool
noOpLog (SentryLevel level , String message , {String ?logger , Object ?exception , StackTrace ?stackTrace → void
notContainsAny (String v , List <String list → bool
once <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ?onError , void onDone ()?, bool ?cancelOnError → Worker
once() will execute only 1 time when condition is met and cancel
the subscription to the listener stream right after that.
condition defines when callback is called, and
can be a bool or a bool Function().
platform (BuildContext context → PlatformTarget
platformPage <T > ({required BuildContext context , Widget ?child , String ?title , String ?name , bool ?maintainState , bool ?fullscreenDialog , LocalKey ?key , String ?restorationId , Object ?arguments , bool allowSnapshotting = true , bool canPop = true , PopInvokedWithResultCallback <T > ?onPopInvoked , PlatformBuilder <MaterialPageData <T > ?material , PlatformBuilder <CupertinoPageData <T > ?cupertino → Page
platformThemeData <T > (BuildContext context , {required T material (ThemeData theme required T cupertino (CupertinoThemeData theme → T
plural (String key , num value , {BuildContext ?context , List <String ?args , Map <String String ?namedArgs , String ?name , NumberFormat ?format , Locale ?locale → String
function translate with pluralization
key Localization key
value Number value for pluralization
BuildContext The location in the tree where this widget builds
args List of localized strings. Replaces {} left to right
namedArgs Map of localized strings. Replaces the name keys {key_name} according to its name
name Name of number value. Replaces {$name} to value
format Formats a numeric value using a NumberFormat class
qValidator (List <TextValidationRule rules , {OnFailureCallBack ?onFail , bool useNations = true → String ? Function(String ?
? build and return String Function(String value)
? which triggers the provided validation rules
setNavigationBarColor ({Color color = Colors.black , bool isDark = false → void
Sets the navigation bar color and icon brightness (usually at the bottom).
setOrientation ({bool isPortrait = true , bool allowRotation = false → void
Locks the screen orientation.
setStatusBarColor ({Color color = Colors.transparent , bool isDark = false → void
Sets the status bar color and icon brightness.
showConfirmDialog ({required String title , required String message , required String lottie , required VoidCallback onConfirmed , required BuildContext context , String confirmText = "Confirm" , String cancelText = "Cancel" , double ?lottieAnimationHeight , Color lottieAnimationBackgroundColor = const Color(0xFF33CDBB) , EdgeInsetsGeometry ?lottieAnimationPadding , TextStyle ?titleTextStyle , TextStyle ?messageTextStyle , TextStyle ?confirmButtonTextStyle , TextStyle ?cancelButtonTextStyle , ButtonStyle ?confirmButtonStyle , ButtonStyle ?cancelButtonStyle → Future <bool
showKeyboard ()
→ void
Attempts to show the keyboard by requesting focus from the current primary focus node.
showPlatformDatePicker ({required BuildContext context , required DateTime initialDate , required DateTime firstDate , required DateTime lastDate , PlatformBuilder <MaterialDatePickerData ?material , PlatformBuilder <CupertinoDatePickerData ?cupertino , DatePickerContentBuilder ?cupertinoContentBuilder → Future <DateTime ?
showPlatformDialog <T > ({required BuildContext context , MaterialDialogData ?material , CupertinoDialogData ?cupertino , WidgetBuilder ?builder , bool ?barrierDismissible , RouteSettings ?routeSettings , bool useRootNavigator = true , String ?barrierLabel , Offset ?anchorPoint , bool ?requestFocus → Future <T? >
showPlatformModalSheet <T > ({required BuildContext context , required WidgetBuilder builder , MaterialModalSheetData ?material , CupertinoModalSheetData ?cupertino , Offset ?anchorPoint , bool ?requestFocus → Future <T? >
Displays either the showModalBottomSheet for material
or showCupertinoModalPopup for cupertino
subscriptionTransformer <T > ({Future handleCancel (StreamSubscription <T > void handlePause (StreamSubscription <T > void handleResume (StreamSubscription <T > → StreamTransformer <T , T >
Creates a StreamTransformer that modifies the behavior of subscriptions to
a stream.
throwIf (bool condition , Object error → void
Two handy functions that help me to express my intention clearer and shorter to check for runtime
errors
throwIfNot (bool condition , Object error → void
toBeginningOfSentenceCase <T extends String ? > (T input , [String ?locale → T
Convert a string to beginning of sentence case, in a way appropriate to the
locale.
toBool (dynamic value → bool
Converts value to bool or throws FormatException if conversion fails.
toBoolOr (dynamic value , {bool fallback = false → bool
Converts value to bool or returns fallback if conversion fails.
toBoolOrNull (dynamic value → bool ?
Safely converts value to bool , or returns null if conversion fails.
toDateTime (dynamic value → DateTime
Converts value to DateTime or throws FormatException if conversion fails.
toDateTimeOr (dynamic value , {required DateTime fallback → DateTime
Converts value to DateTime or returns fallback if conversion fails.
toDateTimeOrNull (dynamic value → DateTime ?
Safely converts value to DateTime , or returns null if conversion fails.
toDouble (dynamic value → double
Converts value to double or throws FormatException if conversion fails.
toDoubleOr (dynamic value , {double fallback = 0.0 → double
Converts value to double or returns fallback if conversion fails.
toDoubleOrNull (dynamic value → double ?
Safely converts value to double , or returns null if conversion fails.
toEnum <T extends Enum > (dynamic value , List <T > values → T
Converts value to an enum or throws FormatException if conversion fails.
toEnumOr <T extends Enum > (dynamic value , List <T > values , {required T fallback → T
Converts value to an enum or returns fallback if conversion fails.
toEnumOrNull <T extends Enum > (dynamic value , List <T > values → T?
Safely converts value to an enum of type T, or returns null if conversion fails.
Requires the list of all enum values (e.g., MyEnum.values).
toInt (dynamic value → int
Converts value to int or throws FormatException if conversion fails.
toIntOr (dynamic value , {int fallback = 0 → int
Converts value to int or returns fallback if conversion fails.
toIntOrNull (dynamic value → int ?
Safely converts value to an int , or returns null if conversion fails.
toList <T > (dynamic value , {T fromJson (dynamic json → List <T >
Converts value to List or throws FormatException if conversion fails.
toListOr <T > (dynamic value , {List <T > fallback = const [] , T fromJson (dynamic json → List <T >
Converts value to List or returns fallback if conversion fails.
toListOrNull <T > (dynamic value , {T fromJson (dynamic json → List <T > ?
Safely converts value to List, or returns null if conversion fails.
toLocalDateTime (dynamic value → DateTime
Converts value to DateTime in local time zone or throws FormatException if conversion fails.
toLocalDateTimeOr (dynamic value , {required DateTime fallback → DateTime
Converts value to DateTime in local time zone or returns fallback if conversion fails.
toLocalDateTimeOrNull (dynamic value → DateTime ?
Safely converts value to DateTime in local time zone, or returns null if conversion fails.
toMap <T , S > (dynamic value → Map <T , S >
Converts value to Map or throws FormatException if conversion fails.
toMapOr <T , S > (dynamic value , {Map <T , S > fallback = const {} → Map <T , S >
Converts value to Map or returns fallback if conversion fails.
toMapOrNull <T , S > (dynamic value → Map <T , S > ?
Safely converts value to a Map, or returns null if conversion fails.
toNum (dynamic value → num
Converts value to num or throws FormatException if conversion fails.
toNumOr (dynamic value , {num fallback = 0 → num
Converts value to num or returns fallback if conversion fails.
toNumOrNull (dynamic value → num ?
Safely converts value to num , or returns null if conversion fails.
toString (dynamic value → String
Converts value to String or throws FormatException if conversion fails.
toStringOr (dynamic value , {String fallback = '' → String
Converts value to String or returns fallback if conversion fails.
toStringOrNull (dynamic value → String ?
Safely converts value to String , or returns null if conversion fails.
toT <T > (dynamic value , {required T fromJson (dynamic json → T
Converts value to T using fromJson or throws FormatException if conversion fails.
toTOr <T > (dynamic value , {required T fromJson (dynamic json required T fallback → T
Converts value to T using fromJson or returns fallback if conversion fails.
toTOrNull <T > (dynamic value , {required T fromJson (dynamic json → T?
Safely converts value to type T using the fromJson function, or returns null if conversion fails.
toUri (dynamic value → Uri
Converts value to Uri or throws FormatException if conversion fails.
toUriOr (dynamic value , {required Uri fallback → Uri
Converts value to Uri or returns fallback if conversion fails.
toUriOrNull (dynamic value → Uri ?
Safely converts value to Uri , or returns null if conversion fails.
tr (String key , {BuildContext ?context , List <String ?args , Map <String String ?namedArgs , String ?gender , Locale ?locale → String
Main function for translate your language keys
key Localization key
BuildContext The location in the tree where this widget builds
args List of localized strings. Replaces {} left to right
namedArgs Map of localized strings. Replaces the name keys {key_name} according to its name
gender Gender switcher. Changes the localized string based on gender string
trExists (String key , {BuildContext ?context → bool
twoDigits (int n → String
typedStreamTransformer <S , T > (StreamTransformer transformer → StreamTransformer <S , T >
Creates a wrapper that coerces the type of transformer.
Typedefs
AddSubscription T >
= FutureOr <void > Function(LightSubscription <T > subs
AnimateCallback
= void Function(AnimationController controller
Function signature for Animate callbacks.
AppRunner
= FutureOr <void > Function()
Runs a callback inside of the runZonedGuarded method, useful for running your runApp(MyApp())
AsyncInstanceBuilderCallback S >
= Future <S > Function()
BeforeBreadcrumbCallback
= Breadcrumb ? Function(Breadcrumb ?breadcrumb , Hint hint
This function is called with an SDK specific breadcrumb object before the breadcrumb is added
to the scope. When nothing is returned from the function, the breadcrumb is dropped
BeforeCaptureCallback
= FutureOr <bool Function(SentryEvent event , Hint hint , bool debounce
A callback which can be used to suppress capturing of screenshots.
It's called in ScreenshotEventProcessor if screenshots are enabled.
This gives more fine-grained control over when capturing should be performed,
e.g., only capture screenshots for fatal events or override any debouncing for important events.
BeforeSendCallback
= FutureOr <SentryEvent ? Function(SentryEvent event , Hint hint
This function is called with an SDK specific event object and can return a modified event
object or nothing to skip reporting the event
BeforeSendLogCallback
= FutureOr <SentryLog ? Function(SentryLog log
This function is called right before a log is about to be sent.
Can return a modified log or null to drop the log.
BeforeSendMetricCallback
= FutureOr <SentryMetric ? Function(SentryMetric metric
This function is called right before a metric is about to be emitted.
Can return true to emit the metric, or false to drop it.
BeforeSendSpanCallback
= FutureOr <void > Function(SentrySpanV2 span
This function is called right before a span is about to be sent.
BeforeSendTransactionCallback
= FutureOr <SentryTransaction ? Function(SentryTransaction transaction , Hint hint
This function is called with an SDK specific transaction object and can return a modified transaction
object or nothing to skip reporting the transaction
BindingBuilderCallback
= void Function()
ClockProvider
= DateTime Function()
Used to provide timestamp for logging.
Condition
= bool Function()
ConnectivityCheckCallback
= Future <InternetCheckResult Function(InternetCheckOption option
A callback function for checking if a specific internet endpoint is
reachable.
ContentLoader
= FutureOr <Uint8List Function()
CreateHttpClient
= HttpClient Function()
The signature of IOHttpClientAdapter.createHttpClient .
Can be used to provide a custom HttpClient for Dio.
CustomEffectBuilder
= Widget Function(BuildContext context , double value , Widget child
DatePickerContentBuilder
= Widget Function(DatePickerContentData data , CupertinoDatePickerData ?cupertinoData
Decoder T >
= T Function(dynamic data
DefaultHttpClientAdapter IOHttpClientAdapter
DefaultTransformer SyncTransformer
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.
DisposingFunc T >
= FutureOr Function(T param
Signature for disposing function
because closures like (x){} have a return type of Null we don't use FutureOr<void>
DscCreatorCallback
= SentryTraceContextHeader Function(RecordingSentrySpanV2 span
Factory for creating a SentryTraceContextHeader from a RecordingSentrySpanV2 .
ErrorBuilder
= Widget Function(BuildContext context , Object error
Signature used by Image.errorBuilder to create a replacement widget to
render instead of the image.
ErrorCallback
= bool Function(Object exception , StackTrace stackTrace
ErrorMapper
= String ? Function(dynamic json
Function that converts json error response from api to error message.
Execute R >
= FutureOr <R > Function()
ExecuteGentle R >
= FutureOr <R > Function(bool
ExecuteGentleWithPort R >
= FutureOr <R > Function(SendPort port , bool
ExecuteWithPort R >
= FutureOr <R > Function(SendPort port
ExitCallback
= FutureOr <bool Function(BuildContext context , GoRouterState state
Signature for function used in RouteBase.onExit.
FactoryFunc T >
= T Function()
Signature of the factory function used by non async factories
FactoryFuncAsync T >
= Future <T > Function()
Signature of the factory function used by async factories
FactoryFuncParam T , P1 , P2 >
= T Function(P1 param1 , P2 param2
For Factories that expect up to two parameters if you need only one use void for the one
you don't use
FactoryFuncParamAsync T , P1 , P2 >
= Future <T > Function(P1 param1 , P2 param2
For async Factories that expect up to two parameters if you need only one use void for the one
you don't use
FlutterOptionsConfiguration
= FutureOr <void > Function(SentryFlutterOptions
Configuration options callback
FontSizeResolver
= double Function(num fontSize , ScreenUtil instance
GetControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
GetPageBuilder
= Widget Function()
GetXControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
GoExceptionHandler
= void Function(BuildContext context , GoRouterState state , GoRouter router
The function signature of GoRouter.onException.
GoRouterBuilderWithNav
= Widget Function(BuildContext context , Widget child
Signature of a go router builder function with navigator.
GoRouterPageBuilder
= Page Function(BuildContext context , GoRouterState state
The page builder for GoRoute .
GoRouterRedirect
= FutureOr <String ? Function(BuildContext context , GoRouterState state
The signature of the redirect callback.
GoRouterWidgetBuilder
= Widget Function(BuildContext context , GoRouterState state
The widget builder for GoRoute .
The signature that iterates header fields.
ImageWidgetBuilder
= Widget Function(BuildContext context , ImageProvider <Object imageProvider
Builder function to create an image widget. The function is called after
the ImageProvider completes the image loading.
InjectorBuilderCallback S >
= S Function(GetInstance
InstanceBuilderCallback S >
= S Function()
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 .
ItemBuilder S >
= Widget Function(BuildContext context , S item , int index
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.
JsonMapper T >
= FutureOr <T > Function(dynamic json
Function that converts json response to the required model.
LoadingErrorWidgetBuilder
= Widget Function(BuildContext context , String url , Object error
Builder function to create an error widget. This builder is called when
the image failed loading, for example due to a 404 NotFound exception.
LogWriterCallback
= void Function(String text , {bool isError
VoidCallback from logs
LottieDecoder
= Future <LottieComposition ? Function(List <int bytes
A function that knows how to transform a list of bytes to a LottieComposition
LottieImageProviderFactory
= ImageProvider <Object ? Function(LottieImageAsset
Mapper T , S >
= FutureOr <S > Function(T data
MultiValueWidgetBuilder
= Widget Function(BuildContext context , List values , Widget ?child
NavigationCallback
= Future <RouteMatchList Function()
The function signature for navigation callbacks in _OnEnterHandler.
NavigatorBuilder
= Widget Function(GlobalKey <NavigatorState navigatorKey , ShellRouteMatch match , RouteMatchList matchList , List <NavigatorObserver ?observers , String ?restorationScopeId
Signature for functions used to build Navigators
NetworkManagerClientFactory
= NetworkManagerClient Function()
NotifierBuilder T >
= Widget Function(T state
OnEnter
= FutureOr <OnEnterResult Function(BuildContext context , GoRouterState currentState , GoRouterState nextState , GoRouter goRouter
The signature for the top-level onEnter callback.
OnEnterThenCallback
= FutureOr <void > Function()
Signature for callbacks invoked after an OnEnterResult is resolved.
OnFailureCallBack
= void Function(String ?input , List <TextValidationRule rules , TextValidationRule failedRule
OnFinishedCallback
= Future <void > Function({DateTime ?endTimestamp , Hint ?hint
OnHttpClientCreate
= HttpClient ? Function(HttpClient client
The signature of IOHttpClientAdapter.onHttpClientCreate .
OnSpanEndCallback
= Future <void > Function(RecordingSentrySpanV2 span
Called when a span ends, allowing the span to be processed or buffered.
OnTap
= void Function(GetSnackBar snack
OnTransactionFinish
= FutureOr <void > Function(ISentrySpan transaction
Called when a transaction is finished.
OptionsConfiguration
= FutureOr <void > Function(SentryOptions
Configuration options callback
ParserExceptionHandler
= RouteMatchList Function(BuildContext context , RouteMatchList routeMatchList
The function signature of GoRouteInformationParser.onParserException .
PathBuilder
= Path Function(Size size
PlaceholderBuilder
= Widget Function(BuildContext context
Builder function to create a placeholder widget. The function is called
once while the ImageProvider is loading the image.
PlaceholderWidgetBuilder
= Widget Function(BuildContext context , String url
Builder function to create a placeholder widget. The function is called
once while the ImageProvider is loading the image.
PlatformBuilder T >
= T Function(BuildContext context , PlatformTarget platform
PlatformIndexBuilder T >
= T Function(BuildContext context , PlatformTarget platform , int index
PlayxAppConfigBuilder
= PlayXAppConfig Function()
Typedefs for configuration builders
PlayxAppRunner
= FutureOr <void > Function()
PlayxEnvSettingsBuilder
= PlayxEnvSettings Function() ?
PlayxLocaleConfigBuilder
= PlayxLocaleConfig Function()
PlayxRouteWidgetBuilder
= Widget Function(BuildContext context , GoRouterState state , bool isInitialized
Builder function for route content that includes initialization state.
PlayxShellWidgetBuilder
= Widget Function(BuildContext context , GoRouterState state , bool isInitialized , Widget child
Builder function for a page's persistent shell (AppBar, Drawer, Scaffold).
PlayxThemeConfigBuilder
= PlayxThemeConfig Function()
PopPageWithRouteMatchCallback
= bool Function(Route route , dynamic result , RouteMatchBase match
Signature for a function that takes in a route to be popped with
the result and returns a boolean decision on whether the pop
is successful.
PrintFunctionCallback
= void Function(String prefix , dynamic value , String info , {bool ?isError
Progress
= dynamic Function(double percent
ProgressCallback
= void Function(int count , int total
The type of a progress listening callback when sending or receiving data.
ProgressIndicatorBuilder
= Widget Function(BuildContext context , String url , DownloadProgress progress
Builder function to create a progress indicator widget. The function is
called every time a chuck of the image is downloaded from the web, but at
least once during image loading.
QueryParameterDecoder T >
= T Function(String value
Signature for custom query parameter decoding functions.
QueryParameterEncoder T >
= String Function(T value
Signature of custom query parameter encoding.
RebuildFactor
= bool Function(MediaQueryData old , MediaQueryData data
RemoveSubscription T >
= FutureOr <bool ? Function(LightSubscription <T > subs
ReparentChildBuilder
= Widget Function(Widget parent , Widget child
The builder type used by Animate.reparentTypes . It must accept an existing
parent widget, and rebuild it with the provided child. In effect, it clones
the provided parent widget with the new child.
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.
ResponseInterceptor T >
= Future <Response<T > ? > Function(Request<T > request , Type targetType , HttpClientResponse response
ResponseStatusFn
= bool Function(Response response
A Callback Function to decide whether the request succeeded or not.
RetryEvaluator
= FutureOr <bool Function(DioException error , int attempt
RouteInfoState RouteInformationState
Type alias for route information state with dynamic type parameter.
RouteMatchVisitor
= bool Function(RouteMatchBase
The function signature for RouteMatchList.visitRouteMatches
RunZonedGuardedOnError
= FutureOr <void > Function(Object StackTrace
Caught exception and stacktrace in runZonedGuarded
RunZonedGuardedRunner
= Future <void > Function()
Called inside of runZonedGuarded
ScopeCallback
= FutureOr <void > Function(Scope
Configures the scope through the callback.
ScopeDisposeFunc
= FutureOr Function()
Signature for disposing function on scope level
ScreenUtilInitBuilder
= Widget Function(BuildContext context , Widget ?child
SdkLogCallback
= void Function(SentryLevel level , String message , {Object ?exception , String ?logger , StackTrace ?stackTrace
Logger callback to log useful debugging information if debug is enabled
SentryFeedbackWidget SentryFeedbackForm
Deprecated alias for SentryFeedbackForm .
SentryScreenshotWidgetOnBuildCallback
= bool Function(SentryScreenshotWidgetStatus currentStatus , SentryScreenshotWidgetStatus ?previousStatus
ShaderUpdateCallback
= EdgeInsets ? Function(ShaderUpdateDetails details
Function signature for ShaderEffect update handlers.
ShellNavigationContainerBuilder
= Widget Function(BuildContext context , StatefulNavigationShell navigationShell , List <Widget children
Builder for a custom container for the branch Navigators of a
StatefulShellRoute .
ShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , Widget child
The widget builder for ShellRoute .
ShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , Widget child
The page builder for ShellRoute .
SnackbarStatusCallback
= void Function(SnackbarStatus ?status
StatefulShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell
The widget builder for StatefulShellRoute .
StatefulShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell
The page builder for StatefulShellRoute .
SvgErrorWidgetBuilder
= Widget Function(BuildContext context , Object error , StackTrace stackTrace
Builder function to create an error widget. This builder is called when
the image failed loading.
SvgImageWidgetBuilder
= Widget Function(BuildContext context , Widget child
Builder function to wrap the successfully loaded SVG widget.
SvgStringGetter
= Future <String ? Function(SvgImageKey key
Get svg string.
ThemeBuilder
= Widget Function(BuildContext XTheme theme
A function that takes the BuildContext and the current XTheme , and returns
a Widget to be built with the current theme.
ThemeSwitcherBuilder
= Widget Function(BuildContext context , XTheme theme
Defines a callback function that takes the
current XTheme and builds a widget based on that theme.
ToggleEffectBuilder
= Widget Function(BuildContext context , bool value , Widget child
TracesSamplerCallback
= double ? Function(SentrySamplingContext samplingContext
UnauthorizedRequestHandler
= void Function(Response ?response
Function that handles unauthorized request.
ValidateCertificate
= bool Function(X509Certificate ?certificate , String host , int port
The signature of IOHttpClientAdapter.validateCertificate .
ValidateStatus
= bool Function(int ?status
The type of a response status code validate callback.
ValueBuilderBuilder T >
= Widget Function(T snapshot , ValueBuilderUpdateCallback <T > updater
ValueBuilderUpdateCallback T >
= void Function(T snapshot
ValueUpdater T >
= T Function()
WidgetCallback
= Widget Function()
WoltModalSheetPageListBuilder
= List <SliverWoltModalSheetPage Function(BuildContext context
Signature for a function that builds a list of SliverWoltModalSheetPage based on the given BuildContext .
WoltModalTypeBuilder
= WoltModalType Function(BuildContext context
Signature for a function that returns the WoltModalType based on the given BuildContext .
WorkerCallback T >
= dynamic Function(T callback
