abzar library

Classes

ActiveNotification
Details of an active notification.
AndroidBitmap<T>
Represents a bitmap on Android.
AndroidEqualizer
An AudioEffect for Android that can adjust the gain for different frequency bands of an AudioPlayer's audio signal.
AndroidEqualizerBand
A frequency band within an AndroidEqualizer.
AndroidEqualizerParameters
The parameter values of an AndroidEqualizer.
AndroidExtractorOptions
AndroidFlutterLocalNotificationsPlugin
Android implementation of the local notifications plugin.
AndroidInitializationSettings
Plugin initialization settings for Android.
AndroidLivePlaybackSpeedControl
Speed control for live streams on Android.
AndroidLoadControl
Buffering and loading options for Android.
AndroidLoudnessEnhancer
An Android AudioEffect that boosts the volume of the audio signal to a target gain, which defaults to zero.
AndroidNotificationAction
Mirrors the Action class in AndroidX.
AndroidNotificationActionInput
Mirrors the RemoteInput functionality available in NotificationCompat.
AndroidNotificationChannel
Settings for Android notification channels.
AndroidNotificationChannelGroup
A group of related Android notification channels.
AndroidNotificationDetails
Contains notification details specific to Android.
AndroidNotificationSound
Represents an Android notification sound.
AndroidUiSettings
A helper class provides properties that can be used to customize the cropper view on Android.
AnsiColor
This class handles colorizing of terminal output.
AssetsLinuxIcon
Represents an icon from the Flutter Assets directory. Currently the assets directory is data/flutter_assets which is located on the path relative to the executable file.
AssetsLinuxSound
Represents a sound from the Flutter Assets directory.
AudioEffect
Subclasses of AudioEffect can be inserted into an AudioPipeline to modify the audio signal outputted by an AudioPlayer. The same audio effect instance cannot be set on multiple players at the same time.
AudioLoadConfiguration
Configuration options to use when loading audio from a source.
AudioPipeline
AudioPlayer
An object to manage playing audio from a URL, a locale file or an asset.
AudioSource
Specifies a source of audio to be played. Audio sources are composable using the subclasses of this class. The same AudioSource instance should not be used simultaneously by more than one AudioPlayer.
Badge
This widget allows you to add badges to any of your Widget.
BadgePosition
Utility class. Don't try to use it!
BadgePositioned
Utility class. Don't try to use it!
BadgeState
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.
BigPictureStyleInformation
Used to pass the content for an Android notification displayed using the big picture style.
BigTextStyleInformation
Used to pass the content for an Android notification displayed using the big text style.
Bill
The means to gathering information from barcode or id and payment id of a bill
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.
BitmapFilePathAndroidIcon
Represents a file path to a bitmap that should be used for as an icon on Android.
BoolList
A space-efficient list of boolean values.
BottomSheetAction
The Actions model that will use on the ActionSheet.
ByteArrayAndroidBitmap
Represents a base64 encoded AndroidBitmap.
ByteArrayAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should be used for as an icon on Android.
ByteDataLinuxIcon
Represents an icon from a raw image data bytes, see LinuxRawIconData.
BytesLoader
An interface that can be implemented to support decoding vector graphic binary assets from different byte sources.
Cache
The cache for decoded SVGs.
CancelAction
The cancel actions model that show under the BottomSheetAction (grouped separately on iOS).
CanonicalizedMap<C, K, V>
A map whose keys are converted to canonical values of type C.
Caption
A representation of a single caption.
CarouselController
CarouselControllerImpl
CarouselOptions
CarouselSlider
CarouselSliderState
CarouselState
CaseInsensitiveEquality
String equality that's insensitive to differences in ASCII case.
CircularPercentIndicator
ClippingAudioSource
An AudioSource that clips the audio of a UriAudioSource between a certain start and end time.
ClosedCaption
Widget for displaying closed captions on top of a video.
ClosedCaptionFile
A structured representation of a parsed closed caption file.
ColorMapper
A class that transforms from one color to another during SVG parsing.
CombinedIterableView<T>
A view of several iterables combined sequentially into a single iterable.
CombinedListView<T>
A view of several lists combined into a single list.
CombinedMapView<K, V>
Returns a new map that represents maps flattened into a single map.
Completer<T>
A way to produce Future objects and to complete them later with a value or error.
ConcatenatingAudioSource
An AudioSource representing a concatenation of multiple audio sources to be played in succession. This can be used to create playlists. Playback between items will be gapless on Android, iOS and macOS, while there will be a slight gap on Web.
ConsoleOutput
Default implementation of LogOutput.
ContentUriAndroidIcon
Represents a content URI that should be used for as an icon on Android.
CropAspectRatio
CroppedFile
A CroppedFile is a cross-platform, simplified File abstraction.
CroppieBoundary
CroppieViewPort
CustomTransition
DarwinAssetOptions
DarwinInitializationSettings
Plugin initialization settings for Darwin-based operating systems such as iOS and macOS
DarwinLoadControl
Buffering and loading options for iOS/macOS.
DarwinNotificationAction
Describes the notification action itself.
DarwinNotificationAttachment
Represents an attachment for a notification on Darwin-based operation systems such as iOS and macOS
DarwinNotificationAttachmentThumbnailClippingRect
Represents the clipping rectangle used for the thumbnail image.
DarwinNotificationCategory
Corresponds to the UNNotificationCategory type which is used to configure notification categories and accompanying options.
DarwinNotificationDetails
Configures notification details specific to Darwin-based operation systems such as iOS and macOS
DashAudioSource
An AudioSource representing a DASH stream. The following URI schemes are supported:
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner.
DeepCollectionEquality
Deep equality on collections.
DefaultEquality<E>
Equality of objects that compares only the natural equality of the objects.
DefaultShuffleOrder
The default implementation of ShuffleOrder which shuffles items with the currently playing item at the head of the order.
DefaultStyleInformation
The default Android notification style.
DefaultSvgTheme
The SVG theme to apply to descendant SvgPicture widgets which don't have explicit theme values.
DelegatingIterable<E>
An Iterable that delegates all operations to a base iterable.
DelegatingList<E>
A List that delegates all operations to a base list.
DelegatingMap<K, V>
A Map that delegates all operations to a base map.
DelegatingQueue<E>
A Queue that delegates all operations to a base queue.
DelegatingSet<E>
A Set that delegates all operations to a base set.
DevelopmentFilter
Prints all logs with level >= Logger.level while in development mode (eg when asserts are evaluated, Flutter calls this debug mode).
DisposableInterface
DottedBorder
Add a dotted border around any child widget. The strokeWidth property defines the width of the dashed border and color determines the stroke paint color. CircularIntervalList is populated with the dashPattern to render the appropriate pattern. The radius property is taken into account only if the borderType is BorderType.RRect. A customPath can be passed in as a parameter if you want to draw a custom shaped border.
DottedLine
DrawableResourceAndroidBitmap
Represents a drawable resource belonging to the Android application that should be used as a bitmap on Android.
DrawableResourceAndroidIcon
Represents a drawable resource belonging to the Android application that should be used as an icon on Android.
DurationRange
Describes a discrete segment of time within a video using a start and end Duration.
Equality<E>
A generic equality relation on objects.
EqualityBy<E, F>
Equality of objects based on derived values.
EqualityMap<K, V>
A Map whose key equality is determined by an Equality object.
EqualitySet<E>
A Set whose key equality is determined by an Equality object.
EventSink<T>
A Sink that supports adding errors.
FastList<T>
FileOutput
FilePathAndroidBitmap
Represents a file path that should be used for a bitmap on Android.
FilePathLinuxIcon
Represents an icon located at the path in the file system. It сan be either an absolute UNIX path or a file:// URI scheme, for example:
FilePicker
The interface that implementations of file_picker must implement.
FilePickerResult
FlutterBitmapAssetAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should be used for as an icon on Android.
FlutterLocalNotificationsPlugin
Provides cross-platform functionality for displaying local notifications.
FormData
FullLifeCycleController
Future<T>
The result of an asynchronous computation.
FutureOr<T>
A type representing values that are either Future<T> or T.
GetBar
GetBuilder<T extends GetxController>
GetBuilderState<T extends GetxController>
GetConnect
GetConnectInterface
GetCupertinoApp
GetDelegate
GetHttpClient
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
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>
GetPageRoute<T>
GetPlatform
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
GetSocket
GetStorage
Instantiate GetStorage to access storage driver apis
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
GetWidget<S extends GetLifeCycleBase?>
GetWidget is a great way of quickly access your individual Controller without having to call Get.find
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>
GraphQLResponse<T>
GroupButton<T>
GroupButtonController
GroupButton Controller for working with GroupButton from the outside
GroupButtonOptions
UI settings of package
HeaderValue
HeapPriorityQueue<E>
Heap based priority queue.
HlsAudioSource
An AudioSource representing an HLS stream. The following URI schemes are supported:
HybridPrinter
A decorator for a LogPrinter that allows for the composition of different printers to handle different log messages. Provide it's constructor with a base printer, but include named parameters for any levels that have a different printer:
IcyHeaders
IcyInfo
IcyMetadata
IdentityEquality<E>
Equality of objects that compares only the identity of the objects.
ImageCropper
A convenient class wraps all api functions of ImageCropper plugin
InboxStyleInformation
Used to pass the content for an Android notification displayed using the inbox style.
IndexedAudioSource
An AudioSource that can appear in a sequence.
InitializationSettings
Settings for initializing the plugin for each platform.
InstanceInfo
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.
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.
IOSFlutterLocalNotificationsPlugin
iOS implementation of the local notifications plugin.
IOSUiSettings
A helper class provides properties that can be used to customize the cropper view on iOS.
IterableEquality<E>
Equality on iterables.
IterableZip<T>
Iterable that iterates over lists of values from other iterables.
LightSubscription<T>
LinearPercentIndicator
LinuxFlutterLocalNotificationsPlugin
A stub implementation to satisfy compilation of multi-platform packages that depend on flutter_local_notifications_linux. This should never actually be created.
LinuxInitializationSettings
Plugin initialization settings for Linux.
LinuxNotificationAction
Represents an action, that send a request message back to the notification client when invoked. This functionality may not be implemented by the notification server, conforming clients should check if it's available using LinuxServerCapabilities. For more information, please see Desktop Notifications Specification https://specifications.freedesktop.org/notification-spec/latest/ar01s02.html
LinuxNotificationDetails
Configures notification details specific to Linux. The system may not support all features.
LinuxNotificationIcon
Represents Linux notification icon.
LinuxNotificationLocation
Represents the location on the screen that the notification should point to.
LinuxNotificationSound
Represents Linux notification sound.
LinuxNotificationTimeout
The timeout of the Linux notification.
LinuxRawIconData
Represents an icon in the raw image data.
LinuxServerCapabilities
Represents capabilities, implemented by the Linux notification server.
ListEquality<E>
Equality on lists.
ListSlice<E>
A list view of a range of another list.
LockCachingAudioSource
This is an experimental audio source that caches the audio while it is being downloaded and played. It is not supported on platforms that do not provide access to the file system (e.g. web).
LogEvent
LogFilter
An abstract filter of log messages.
LogfmtPrinter
Outputs a logfmt message:
Logger
Use instances of logger to send log messages to the LogPrinter.
LogOutput
Log output receives a OutputEvent from LogPrinter and sends it to the desired destination.
LogPrinter
An abstract handler of log events.
LoopingAudioSource
MacOSFlutterLocalNotificationsPlugin
macOS implementation of the local notifications plugin.
MapEquality<K, V>
Equality on maps.
MapKeySet<E>
An unmodifiable Set view of the keys of a Map.
MapValueSet<K, V>
Creates a modifiable Set view of the values of a Map.
MediaStyleInformation
Used to pass the content for an Android notification displayed using the media style.
MemoryOutput
Buffers OutputEvents.
Message
Represents a message used in Android messaging style notifications.
MessagingStyleInformation
Used to pass the content for an Android notification displayed using the messaging style.
MicroMoney
Used primarily for currency formatting, this number-like class stores millionths of a currency unit, typically as an Int64.
Microtask
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MultiEquality<E>
Combines several equalities into a single equality.
MultiOutput
Logs simultaneously to multiple LogOutput outputs.
MultipartFile
MultiStreamController<T>
An enhanced stream controller provided by Stream.multi.
Node<T>
NonGrowableListMixin<E>
Mixin class that implements a throwing version of all list operations that change the List's length.
NonGrowableListView<E>
A fixed-length list.
NotificationAppLaunchDetails
Contains details on the notification that launched the application.
NotificationDetails
Contains notification details specific to each platform.
NotificationResponse
Details of a Notification Action that was triggered.
NumberFormat
Provides the ability to format a number in a locale-specific way.
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
OutputEvent
PageRedirect
PathDecoded
PendingNotificationRequest
Details of a pending notification that has not been delivered.
Permission
Defines the permissions which can be checked and requested.
PermissionWithService
A special kind of permission, used to access a service.
Person
Details of a person e.g. someone who sent a message.
PictureInfo
The deocded result of a vector graphics asset.
PictureProvider
Deprecated class, will be removed, does not do anything.
Plate
Takes motorcycle or car plate and gives information based on it
PlatformFile
PlatformUiSettings
An abstract class encapsulates UI attributes for customization
PlaybackEvent
Encapsulates the playback state and current position of the player.
PlayerState
Encapsulates the playing and processing states. These two states vary orthogonally, and so if processingState is ProcessingState.buffering, you can check playing to determine whether the buffering occurred while the player was playing or while the player was paused.
PositionDiscontinuity
Information collected when a position discontinuity occurs.
PrefixPrinter
A decorator for a LogPrinter that allows for the prepending of every line in the log output with a string for the level of that log. For example:
PrettyPrinter
Default implementation of LogPrinter.
PriorityQueue<E>
A priority queue is a priority based work-list of elements.
ProductionFilter
Prints all logs with level >= Logger.level even in production.
ProgressiveAudioSource
An AudioSource representing a regular media file such as an MP3 or M4A file. The following URI schemes are supported:
ProgressiveAudioSourceOptions
QueueList<E>
A class that efficiently implements both Queue and List.
RadarChart
RadarChartPainter
RatingBar
A widget to receive rating input from users.
RatingBarIndicator
A widget to display rating as assigned using rating property.
RatingWidget
Defines widgets which are to used as rating bar items.
RawResourceAndroidNotificationSound
Represents a raw resource belonging to the Android application that should be used for the notification sound.
ReadWriteValue<T>
Response<T>
ResponsiveScreen
ResponsiveScreenSettings
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
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]
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.
SequenceState
Encapsulates the sequence and currentIndex state and ensures consistency such that currentIndex is within the range of sequence.length. If sequence.length is 0, then currentIndex is also 0.
SetEquality<E>
Equality of sets.
Share
Plugin for summoning a platform share sheet.
SharePlusLinuxPlugin
The Linux implementation of SharePlatform.
SharePlusWindowsPlugin
The fallback Windows implementation of SharePlatform, for older Windows versions.
ShareResult
The result of a share to determine what action the user has taken.
Sheba
Takes Sheba code and gives information from it
ShuffleOrder
Defines the algorithm for shuffling the order of a ConcatenatingAudioSource. See DefaultShuffleOrder for a default implementation.
SilenceAudioSource
An AudioSource for a period of silence.
SimpleBuilder
SimpleBuilderState
SimplePrinter
Outputs simple log messages:
SnackbarController
Stream<T>
A source of asynchronous data events.
StreamAudioResponse
The response for a StreamAudioSource. This API is experimental.
StreamAudioSource
An AudioSource that provides audio dynamically. Subclasses must override request to provide the encoded audio data. This API is experimental.
StreamConsumer<S>
Abstract interface for a "sink" accepting multiple entire streams.
StreamController<T>
A controller with the stream it controls.
StreamIterator<T>
An Iterator-like interface for the values of a Stream.
StreamOutput
StreamSink<S>
A object that accepts stream events both synchronously and asynchronously.
StreamSubscription<T>
A subscription on events from a Stream.
StreamTransformer<S, T>
Transforms a Stream.
StreamTransformerBase<S, T>
Base class for implementing StreamTransformer.
StreamView<T>
Stream wrapper that only exposes the Stream interface.
StyleInformation
Abstract class for defining an Android notification style
SubRipCaptionFile
Represents a ClosedCaptionFile, parsed from the SubRip file format. See: https://en.wikipedia.org/wiki/SubRip
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.
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.
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.
SynchronousStreamController<T>
A stream controller that delivers its events synchronously.
TabBarViewModel
TextDirection
Represents directionality of text.
ThemeLinuxIcon
Represents a system theme icon. See https://www.freedesktop.org/wiki/Specifications/icon-naming-spec/ for more help.
ThemeLinuxSound
Represents a system theme sound. See https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/ for more help.
Time
Used for specifying a time in 24 hour format.
Timer
A countdown timer that can be configured to fire once or repeatedly.
Translations
TrustedCertificate
UnionSet<E>
A single set that provides a view of the union over a set of sets.
UnionSetController<E>
A controller that exposes a view of the union of a collection of sets.
UnmodifiableListView<E>
An unmodifiable List view of another List.
UnmodifiableMapMixin<K, V>
Mixin class that implements a throwing version of all map operations that change the Map.
UnmodifiableMapView<K, V>
View of a Map that disallow modifying the map.
UnmodifiableSetMixin<E>
Mixin class that implements a throwing version of all set operations that change the Set.
UnmodifiableSetView<E>
An unmodifiable set.
UnorderedIterableEquality<E>
Equality of the elements of two iterables without considering order.
UriAndroidNotificationSound
Represents a URI on the Android device that should be used for the notification sound.
UriAudioSource
An abstract class representing audio sources that are loaded from a URI.
UtilitiesConstants
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
ValueStorage<T>
VectorGraphicUtilities
Utility functionality for interaction with vector graphic assets.
VideoPlayer
Widget that displays the video controlled by controller.
VideoPlayerController
Controls a platform video player, and provides updates when the state is changing.
VideoPlayerOptions
VideoPlayerOptions can be optionally used to set additional player settings
VideoPlayerValue
The duration, current position, buffering state, error state and settings of a VideoPlayerController.
VideoProgressColors
Used to configure the VideoProgressIndicator widget's colors for how it describes the video's status.
VideoProgressIndicator
Displays the play/buffering status of the video controlled by controller.
VideoScrubber
A scrubber to control VideoPlayerControllers
WebTranslations
WebUiSettings
WebViewConfiguration
Additional configuration options for LaunchMode.inAppWebView.
WebVTTCaptionFile
Represents a ClosedCaptionFile, parsed from the WebVTT file format. See: https://en.wikipedia.org/wiki/WebVTT
Worker
Workers
XFile
A CrossFile is a cross-platform, simplified File abstraction.
Zone
A zone represents an environment that remains stable across asynchronous calls.
ZoneDelegate
An adapted view of the parent zone.
ZoneSpecification
A parameter object with custom zone function handlers for Zone.fork.

Enums

AndroidNotificationCategory
The available categories for Android notifications.
AndroidNotificationChannelAction
The available actions for managing notification channels.
AndroidNotificationStyle
The available notification styles on Android.
AndroidScheduleMode
Used to specify how notifications should be scheduled on Android.
AndroidServiceForegroundType
The available foreground types for an Android service.
AndroidServiceStartType
The available start types for an Android service.
ArcType
AudioAttributesUsage
The available audio attributes usages for an Android service.
BadgeAnimationType
This is a set of animations that you can use for your Badge widget.
BadgeShape
This is a set of shapes that you can use for your Badge widget.
BorderType
The different supported BorderTypes
CarouselPageChangedReason
CenterPageEnlargeStrategy
CircularStrokeCap
CropAspectRatioPreset
A set of preset values can be used to setup the menu of crop aspect ratio options in the cropper view.
CropperPresentStyle
CropStyle
Crop style options. There're two supported styles, rectangle and circle. These style will changes the shape of crop bounds, rectangle or circle bounds.
CrossGroupAlignment
How the buttons should be placed along the cross axis in a layout
DarwinNotificationActionOption
Describes when & how the notification action is displayed.
DarwinNotificationCategoryOption
Desribes the options of each notification category.
DataSourceType
The way in which the video was originally loaded.
DateTimeComponents
The components of a date and time representations.
Day
The days of the week.
DigitLocale
Determines language of the digits in wordsToNumber and wordsToNumberString functions.
FilePickerStatus
FileType
GroupAlertBehavior
The available alert behaviours for grouped notifications.
GroupingType
Responsible for how the buttons will be grouped
GroupRunAlignment
How the button runs themselves should be placed the cross axis in a layout
ImageCompressFormat
Supported image compression formats
Importance
The available importance levels for Android notifications.
InterruptionLevel
Type used to indicate the importance and delivery timing of a notification.
LaunchMode
The desired mode to launch a URL.
Level
Levels to control logging output. Logging can be enabled to include all levels above certain Level.
LinuxHintValueType
Represents the notification hint value type.
LinuxIconType
Specifies the Linux notification icon type.
LinuxNotificationCategory
Categories of notifications.
LinuxNotificationUrgency
The urgency level of the Linux notification.
LinuxSoundType
Specifies the Linux notification sound type.
LoopMode
An enumeration of modes that can be passed to AudioPlayer.setLoopMode.
MainGroupAlignment
How the buttons should be placed in the main axis in a layout
NotificationResponseType
The possible notification response types
NotificationVisibility
Defines the notification visibility on the lockscreen.
PageState
PermissionStatus
Defines the state of a Permission.
PopMode
Enables the user to customize the intended pop behavior
PositionDiscontinuityReason
The reasons for position discontinuities.
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that shouldn't be duplicates
Priority
Priority for notifications on Android 7.1 and lower.
ProcessingState
Enumerates the different processing states of a player.
RepeatInterval
The available intervals for periodically showing notifications.
RotationAngle
RowStyle
ScreenType
ServiceStatus
Defines the different states a service can be in.
ShareResultStatus
How the user handled the share-sheet
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.keepFactoryJust 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
StorageDirectory
Corresponds to constants defined in Androids android.os.Environment class.
Transition
UILocalNotificationDateInterpretation
Describes how the fire date (date used to schedule a notification) of the UILocalNotification on iOS is interpreted.
VideoFormat
The file format of the given video.
WebCrossOrigin
Possible values that can be passed to AudioPlayer.setWebCrossOrigin.

Mixins

AndroidAudioEffect
An AudioEffect that supports Android.
DarwinAudioEffect
An AudioEffect that supports iOS and macOS.
FullLifeCycleMixin
GetLifeCycleBase
The GetLifeCycle
GetResponsiveMixin
GetSingleTickerProviderStateMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
GetStateUpdaterMixin<T extends StatefulWidget>
Complies with GetStateUpdater
GetTickerProviderStateMixin
Used like TickerProviderMixin but only with Get Controllers. Simplifies multiple AnimationController creation inside GetxController.
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
NotifyManager<T>
PageRouteReportMixin<T>
RxObjectMixin<T>
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.
ScrollMixin
SingleGetTickerProviderMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
StateMixin<T>

Extensions

AddOrdinalSuffix on String
String Extension wrapper to adding ordinal suffix to String object
AlignExtensions on Widget
BankNameFromCardNumber on String
String Extension wrapper to getting bank name from String object
BoolExtension on bool
CircularStrokeCapExtension on CircularStrokeCap
CommasNum on num
num Extension wrapper to adding comma to the String object
CommasString on String
String Extension wrapper to removing and adding comma to the String object
ComparatorExtension on Comparator<T>
Extensions on comparator functions.
ContextExtensionss on BuildContext
Data on T
DateTimeExtensions on DateTime
DoubleExtension on double
ExtensionBottomSheet on GetInterface
ExtensionDialog on GetInterface
ExtensionSnackbar on GetInterface
FileExtension on File
FirstWhereExt on List<T>
FutureExtensions on Future<T>
Convenience methods on futures.
FutureIterable on Iterable<Future<T>>
FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureRecord2 on (Future<T1>, Future<T2>)
Parallel operations on a record of futures.
FutureRecord3 on (Future<T1>, Future<T2>, Future<T3>)
Parallel operations on a record of futures.
FutureRecord4 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>)
Parallel operations on a record of futures.
FutureRecord5 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>)
Parallel operations on a record of futures.
FutureRecord6 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>)
Parallel operations on a record of futures.
FutureRecord7 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>)
Parallel operations on a record of futures.
FutureRecord8 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>)
Parallel operations on a record of futures.
FutureRecord9 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>, Future<T9>)
Parallel operations on a record of futures.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
GenericIterableExtentions on Iterable
GetDurationUtils on Duration
Duration utilities.
GetDynamicUtils on dynamic
GetNavigation on GetInterface
GetNumUtils on num
GetResetExt on GetInterface
GetStringUtils on String
Inst on GetInterface
IntExtension on int
IntExtesion on int
IterableComparableExtension on Iterable<T>
Extensions that apply to iterables of Comparable elements.
IterableDoubleExtension on Iterable<double>
Extension on iterables of double.
IterableExtension on Iterable<T>
Extensions that apply to all iterables.
IterableExtensions on Iterable<T>
IterableIntegerExtension on Iterable<int>
Extension on iterables of integers.
IterableIterableExtension on Iterable<Iterable<T>>
Extensions on iterables whose elements are also iterables.
IterableNullableExtension on Iterable<T?>
Extensions that apply to iterables with a nullable element type.
IterableNumberExtension on Iterable<num>
Extensions that apply to iterables of numbers.
ListComparableExtensions on List<E>
Various extensions on lists of comparable elements.
ListExtension on List<E>
ListExtensions on List<E>
Various extensions on lists of arbitrary elements.
LocalesIntl on GetInterface
LoopEventsExt on GetInterface
MapExtension on Map<K, V>
NationalId on String
String Extension wrapper to checking iranian national id verification
NullableIterableExtentions on Iterable?
NumberToPersianWordsInt on int
int Extension wrapper to convert number to Persian word on int object
NumberToPersianWordsString on String
String Extension wrapper to convert number to Persian word on String object
OverlayExt on GetInterface
PagesListExt on List<GetPage>
PageStateExtension on PageState
PermissionActions on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts on Permission
Shortcuts for checking the status of a Permission.
PermissionListActions on List<Permission>
Actions that can be taken on a List of Permissions.
PermissionStatusGetters on PermissionStatus
Utility getter extensions for the PermissionStatus type.
PhoneNumberExtension on String
String Extension wrapper to use getPhonePrefix, getPhoneNumberDetail and phoneNumberValidator on String object
PlaceByNationalId on String
String Extension wrapper to getting place information from String object as national id
Precision on double
ReactiveT on T
RemoveOrdinalSuffix on String
String Extension wrapper to remove ordinal suffix on String object
RxBoolExt on Rx<bool>
RxDoubleExt on Rx<double>
RxIntExt on Rx<int>
RxnBoolExt on Rx<bool?>
RxnDoubleExt on Rx<double?>
RxnIntExt on Rx<int?>
RxnNumExt on Rx<T?>
RxnStringExt on Rx<String?>
RxNumExt on Rx<T>
RxPageStateExtension on Rx<PageState>
RxStringExt on Rx<String>
RxT on T
ServicePermissionActions on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus
Utility getter extensions for the ServiceStatus type.
SetExtension on Set<E>
StateExt on StateMixin<T>
StringExtension on String
StringExtensions on String
StyledText on T
TextExtension on Text
TextStyleExtension on TextStyle
Trans on String
VehiclePlate on String
String Extension wrapper to creating plate based on the String object
WidgetMarginX on Widget
Add margin property to widget
WidgetPaddingX on Widget
add Padding Property to widget
WidgetsExtension on Widget
WidgetSliverBoxX on Widget
Allows you to insert widgets inside a CustomScrollView
WordsToNumber on String
String Extension wrapper to convert String object to its equivalent number in int and String.

Properties

appBuildNumber → Future<String>
no setter
appName → Future<String>
no setter
appPackageName → Future<String>
no setter
appVersion → Future<String>
no setter
billTypesMap → Map<int, String>
Saves bill types as a Map<int, String>
final
context ↔ BuildContext
getter/setter pair
currentLocale ↔ Locale?
getter/setter pair
disablePathProviderPlatformOverride ← bool
no getter
Get → _GetImpl
final
isAndroid ↔ bool
getter/setter pair
isDebugMode ↔ bool
getter/setter pair
isDesktop ↔ bool
getter/setter pair
isFuchsia ↔ bool
getter/setter pair
isIos ↔ bool
getter/setter pair
isLandScape ↔ bool
getter/setter pair
isLinux ↔ bool
getter/setter pair
isMacOs ↔ bool
getter/setter pair
isMobile ↔ bool
getter/setter pair
isPhone ↔ bool
getter/setter pair
isPortrait ↔ bool
getter/setter pair
isTablet ↔ bool
getter/setter pair
isWeb ↔ bool
getter/setter pair
isWindows ↔ bool
getter/setter pair
It replaces the Flutter Navigator, but needs no context. You can to use navigator.push(YourRoute()) rather Navigator.push(context, YourRoute());
no setter
screenHeight ↔ double
getter/setter pair
screenWidth ↔ double
getter/setter pair
svg → Svg
Instance for Svg's utility methods, which can produce a DrawableRoot or PictureInfo from String or Uint8List.
final
textTheme ↔ TextTheme
getter/setter pair
theme ↔ ThemeData
getter/setter pair

Functions

addCommas(Object number) → String
Takes an integer or string and add commas as separator NOTE: it converts Fa digits to En digits
addOrdinalSuffix(String number) → String
Adds ordinal suffixes to numbers
ambiguate<T>(T? value) → T?
back() → void
binarySearch<E>(List<E> sortedList, E value, {int compare(E, E)?}) → int
Returns a position of the value in sortedList, if it is there.
bodyBytesToString(Stream<List<int>> bodyBytes, Map<String, String> headers) → Future<String>
call(String phone) → void
canLaunch(String urlString) → Future<bool>
Checks whether the specified URL can be handled by some app installed on the device.
canLaunchUrl(Uri url) → Future<bool>
Checks whether the specified URL can be handled by some app installed on the device.
carHandler(NormalizedPlate plate) → PlateInfo
Gives car's plate information from its normalized form of the plate
centerProgress() → Widget
centerProgressCupertino() → Widget
closeInAppWebView() → Future<void>
Closes the current in-app web view, if one was previously opened by launchUrl.
closeWebView() → Future<void>
Closes the current WebView, if one was previously opened via a call to launch.
column({EdgeInsets padding = EdgeInsets.zero, EdgeInsets margin = EdgeInsets.zero, List<Widget> children = const <Widget>[], MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start, MainAxisSize mainAxisSize = MainAxisSize.max, CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center, VerticalDirection verticalDirection = VerticalDirection.down, BoxDecoration? decoration, double? width, double? height, bool isScrollable = false, ScrollPhysics? physics, VoidCallback? onTap, ScrollController? scrollController}) → Widget
compareAsciiLowerCase(String a, String b) → int
Compares a and b lexically, converting ASCII letters to lower case.
compareAsciiLowerCaseNatural(String a, String b) → int
Compares strings a and b according to lower-case natural sort ordering.
compareAsciiUpperCase(String a, String b) → int
Compares a and b lexically, converting ASCII letters to upper case.
compareAsciiUpperCaseNatural(String a, String b) → int
Compares strings a and b according to upper-case natural sort ordering.
compareNatural(String a, String b) → int
Compares strings a and b according to natural sort ordering.
convertArToEn(String digits) → String
Takes a String that includes Arabic digits and converts them to English digits
convertArToFa(String digits) → String
Takes a String that includes Arabic digits and converts them to Persian digits
convertEnToAr(String digits) → String
Takes a String that includes English digits and coverts them to Persian digits
convertEnToFa(String digits) → String
Takes a String that includes English digits and coverts them to Persian digits
convertFaToEn(String digits) → String
Takes a String that includes Persian digits and converts them to English digits
cropImage({required File file, dynamic action(CroppedFile file)?, int? maxWidth, int? maxHeight, CropStyle cropStyle = CropStyle.rectangle, CropAspectRatio cropAspectRatio = const CropAspectRatio(ratioX: 3, ratioY: 1.2), ImageCompressFormat imageCompressFormat = ImageCompressFormat.png, AndroidUiSettings? androidUiSettings, IOSUiSettings? iOSUiSettings, List<CropAspectRatioPreset> aspectRatioPresets = const <CropAspectRatioPreset>[CropAspectRatioPreset.original, CropAspectRatioPreset.square, CropAspectRatioPreset.ratio3x2, CropAspectRatioPreset.ratio4x3, CropAspectRatioPreset.ratio16x9]}) → Future<CroppedFile?>
dashedDivider({double? height}) → Widget
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.
defaultLogWriterCallback(String value, {bool isError = false}) → void
default logger from GetX
defaultTabBar({required List<TabBarViewModel> tabs, required Widget tabBar, double? width, double? height = 500, int initialIndex = 0}) → Widget
delay(int milliseconds, VoidCallback action) → void
dialog(Widget page, {bool dialog = false, VoidCallback? onDismiss}) → Future<void>
directionality({required bool rtl, required Widget child}) → Widget
dismissEasyLoading() → Future<void>
divider({double? width, double height = 0.6, Color color = Colors.grey, EdgeInsets? padding}) → Widget
email(String email, String subject) → void
equalsIgnoreAsciiCase(String a, String b) → bool
Checks if strings a and b differ only on the case of ASCII letters.
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.
getApplicationCacheDirectory() → Future<Directory>
Path to a directory where the application may place application-specific cache files.
getApplicationDocumentsDirectory() → Future<Directory>
Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportDirectory() → Future<Directory>
Path to a directory where the application may place application support files.
getBankNameFromCardNumber(String cardNumber) → Bank?
Checks the cardNumber is a valid bank card and returns the Bank info if it isn't a valid card or not related to a bank it will returns null
getDownloadsDirectory() → Future<Directory?>
Path to the directory where downloaded files can be stored.
getExternalCacheDirectories() → Future<List<Directory>?>
Paths to directories where application specific cache data can be stored externally.
getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>
Paths to directories where application specific data can be stored externally.
getExternalStorageDirectory() → Future<Directory?>
Path to a directory where the application may access top level storage.
getLibraryDirectory() → Future<Directory>
Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getPhoneNumberDetail(String phoneNumber) → OperatorDetail?
Finds information such as province, type and model of phone number.
getPhonePrefix(String phoneNumber) → String
Returns the phone number prefix
getPlaceByIranNationalId(String nationalId) → NationalIdPlace?
Gives the place information based on the given String as national id
getPlateHandler(NormalizedPlate plate) → PlateHandler
Gives plate handler based on normalized form of the plate
getPlateInfo(NormalizedPlate plate) → PlateInfo
Gives plate information from its normalized form in normalizePlate
getRealIndex(int position, int base, int? length) → int
Converts an index of a set size to the corresponding index of a collection of another size as if they were circular.
getTemporaryDirectory() → Future<Directory>
Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
groupBy<S, T>(Iterable<S> values, T key(S)) → Map<T, List<S>>
Groups the elements in values by the value returned by key.
hashIgnoreAsciiCase(String string) → int
Hash code for a string which is compatible with equalsIgnoreAsciiCase.
hasPersian(String input, [bool isComplex = false]) → bool
Check is the input string includes Persian alphabet or not returns true if the input is matched with Farsi char dataset RegExp, if not returns false
iconTextHorizontal({required Widget leading, required Widget trailing, EdgeInsets margin = EdgeInsets.zero, VoidCallback? onTap, double spaceBetween = 6, MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start, CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center, MainAxisSize mainAxisSize = MainAxisSize.min}) → Widget
iconTextVertical({required Widget leading, required Widget trailing, EdgeInsets margin = EdgeInsets.zero, VoidCallback? onTap, double spaceBetween = 6, MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start, CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center, MainAxisSize mainAxisSize = MainAxisSize.min}) → Widget
image(String source, {Color? color, double? width, double? height, BoxFit fit = BoxFit.contain, Clip clipBehavior = Clip.hardEdge, double borderRadius = 1, EdgeInsets margin = EdgeInsets.zero, String? placeholder, VoidCallback? onTap}) → Widget
imageAsset(String asset, {Color? color, double? width, double? height, BoxFit fit = BoxFit.contain, Clip clipBehavior = Clip.hardEdge, double borderRadius = 1, EdgeInsets margin = EdgeInsets.zero, VoidCallback? onTap}) → Widget
imageFile(File file, {Color? color, double? width, double? height, BoxFit fit = BoxFit.contain, Clip clipBehavior = Clip.hardEdge, double borderRadius = 1, EdgeInsets margin = EdgeInsets.zero, VoidCallback? onTap}) → Widget
imageNetwork(String url, {Color? color, double? width, double? height, BoxFit fit = BoxFit.contain, Clip clipBehavior = Clip.hardEdge, double borderRadius = 1, EdgeInsets margin = EdgeInsets.zero, VoidCallback? onTap, String? placeholder}) → Widget
initUtilities() → void
insertionSort<E>(List<E> elements, {int compare(E, E)?, int start = 0, int? end}) → void
Sort a list between start (inclusive) and end (exclusive) using insertion sort.
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).
isEasyLoadingShow() → bool
isPersian(String input, [bool isComplex = false, Pattern? trimPattern]) → bool
Check is the input string Persian or not returns true if the input is matched with Farsi char dataset RegExp, if not returns false
isPlateNumberValid(String number) → bool
Checks plate number validation
isPlateValid(PlateInfo plateInfo, NormalizedPlate normalizedPlate) → bool
Checks plate validation
lastBy<S, T>(Iterable<S> values, T key(S)) → Map<T, S>
Associates the elements in values by the value returned by key.
launch(String urlString, {bool? forceSafariVC, bool forceWebView = false, bool enableJavaScript = false, bool enableDomStorage = false, bool universalLinksOnly = false, Map<String, String> headers = const <String, String>{}, Brightness? statusBarBrightness, String? webOnlyWindowName}) → Future<bool>
Parses the specified URL string and delegates handling of it to the underlying platform.
launchInstagram(String username, {LaunchMode mode = LaunchMode.externalApplication}) → void
launchLinkedIn(String username, {LaunchMode mode = LaunchMode.externalApplication}) → void
launchTelegram(String id, {LaunchMode mode = LaunchMode.externalApplication}) → void
launchTwitter(String username, {LaunchMode mode = LaunchMode.externalApplication}) → void
launchUrl(Uri url, {LaunchMode mode = LaunchMode.platformDefault, WebViewConfiguration webViewConfiguration = const WebViewConfiguration(), String? webOnlyWindowName}) → Future<bool>
Passes url to the underlying platform for handling.
launchURL(String url, {LaunchMode mode = LaunchMode.externalApplication}) → Future<void>
launchWhatsApp(String number, {LaunchMode mode = LaunchMode.externalApplication}) → void
launchYouTube(String username, {LaunchMode mode = LaunchMode.externalApplication}) → void
lowerBound<E>(List<E> sortedList, E value, {int compare(E, E)?}) → int
Returns the first position in sortedList that does not compare less than value.
mapMap<K1, V1, K2, V2>(Map<K1, V1> map, {K2 key(K1, V1)?, V2 value(K1, V1)?}) → Map<K2, V2>
Creates a new map from map with new keys and values.
maxBy<S, T>(Iterable<S> values, T orderBy(S), {int compare(T, T)?}) → S?
Returns the element of values for which orderBy returns the maximum value.
mergeMaps<K, V>(Map<K, V> map1, Map<K, V> map2, {V value(V, V)?}) → Map<K, V>
Returns a new map with all key/value pairs in both map1 and map2.
mergeSort<E>(List<E> elements, {int start = 0, int? end, int compare(E, E)?}) → void
Sorts a list between start (inclusive) and end (exclusive) using the merge sort algorithm.
minBy<S, T>(Iterable<S> values, T orderBy(S), {int compare(T, T)?}) → S?
Returns the element of values for which orderBy returns the minimum value.
motorcycleHandler(NormalizedPlate plate) → PlateInfo
Gives motorcycle's plate information from its normalized form of the plate
normalizePlate(String plate) → NormalizedPlate
Normalizes the Plate (or separate char part from number part)
numberToWords(int number, {bool ordinal = false}) → String
Returns Persian word of the given number in int You can determine returned string has ordinal suffix or not by ordinal flag.
numberToWordsString(String number, {bool ordinal = false}) → String?
Returns Persian word of the given number in String. Number can contain commas. You can determine returned string has ordinal suffix or not by ordinal flag.
off(Widget page) → void
offAll(Widget page, {bool dialog = false, Transition transition = Transition.cupertino, int milliSecondDelay = 1}) → Future<void>
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().
openAppSettings() → Future<bool>
Opens the app settings page.
otpTextField({int length = 4, bool autoFocus = false, TextEditingController? controller, MainAxisAlignment mainAxisAlignment = MainAxisAlignment.spaceBetween, String? hintCharacter, void onCompleted(String)?, double borderRadius = 8, PinCodeFieldShape shape = PinCodeFieldShape.box, EdgeInsetsGeometry? fieldOuterPadding, double fieldHeight = 64, double fieldWidth = 60, double borderWidth = 1, Color? fillColor, Color? cursorColor, Color? borderColor}) → Widget
phoneNumberValidator(String phoneNumber) → bool
validate phone number and returns true if the given String phone number matched with pattern otherwise returns false.
plusMinus({required dynamic onChanged(int), int range = 1, int defaultValue = 0, Widget? addWidget, Widget? minusWidget, double spaceBetween = 10, TextStyle? textStyle, MainAxisAlignment mainAxisAlignment = MainAxisAlignment.center, MainAxisSize mainAxisSize = MainAxisSize.min}) → Widget
push(Widget page, {bool dialog = false, Transition transition = Transition.cupertino, bool preventDuplicates = true, int milliSecondDelay = 1}) → Future<void>
radians(num deg) → num
radius({required Widget child, required double radius}) → Widget
remainder(int input, int? source) → int
Returns the remainder of the modulo operation input % source, and adjust it for negative values.
removeCommas(String number) → num
Takes a string and it should be includes integer then remove all the commas
removeOrdinalSuffix(String word) → String
Removes ordinal suffixes to numbers
reverse<E>(List<E> elements, [int start = 0, int? end]) → void
Reverses a list, or a part of a list, in-place.
row({EdgeInsets padding = EdgeInsets.zero, EdgeInsets margin = EdgeInsets.zero, List<Widget> children = const <Widget>[], MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start, MainAxisSize mainAxisSize = MainAxisSize.max, CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center, VerticalDirection verticalDirection = VerticalDirection.down, BoxDecoration? decoration, double? width, double? height, bool isScrollable = false, ScrollPhysics? physics, ScrollController? scrollController, VoidCallback? onTap}) → Widget
runZoned<R>(R body(), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification, Function? onError}) → R
Runs body in its own zone.
runZonedGuarded<R>(R body(), void onError(Object error, StackTrace stack), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification}) → R?
Runs body in its own error zone.
scaffold({required Widget body, Key? key, PreferredSizeWidget? appBar, Widget? drawer, Widget? endDrawer, Widget? floatingActionButton, Widget? bottomNavigationBar, EdgeInsets? padding, Color? color, BoxDecoration? decoration, bool resizeToAvoidBottomInset = false, bool extendBodyBehindAppBar = false, FloatingActionButtonLocation floatingActionButtonLocation = FloatingActionButtonLocation.endFloat, BoxConstraints? constraints, Alignment? alignment}) → Widget
scheduleMicrotask(void callback()) → void
Runs a function asynchronously.
shareFile(List<XFile> pathFiles, String text) → void
shareText(String text, {String? subject}) → void
showAdaptiveActionSheet<T>({required BuildContext context, required List<BottomSheetAction> actions, Widget? title, CancelAction? cancelAction, Color? barrierColor, Color? bottomSheetColor}) → Future<T?>
A action bottom sheet that adapts to the platform (Android/iOS).
showEasyError() → Future<void>
showEasyLoading() → Future<void>
showFilePicker({required dynamic action(List<File> file), FileType fileType = FileType.image, bool allowMultiple = false, List<String>? allowedExtensions}) → void
shuffle(List elements, [int start = 0, int? end, Random? random]) → void
Shuffles a list randomly.
sms(String phone) → void
stronglyConnectedComponents<T>(Map<T, Iterable<T>> graph) → List<Set<T>>
Returns the strongly connected components of graph, in topological order.
supportsCloseForLaunchMode(LaunchMode mode) → Future<bool>
Returns true if closeInAppWebView is supported for mode in the current platform implementation.
supportsLaunchMode(LaunchMode mode) → Future<bool>
Returns true if mode is supported by the current platform implementation.
textFieldCountry({TextEditingController? controller, String initialIsoCode = "IR", void onChanged(String)?, String hintText = "Phone number", PhoneInputSelectorType selectorType = PhoneInputSelectorType.DIALOG, Color? fillColor, Color borderColor = Colors.grey, double borderRadius = 12, int maxLength = 10}) → Widget
toBeginningOfSentenceCase(String? input, [String? locale]) → String?
Convert a string to beginning of sentence case, in a way appropriate to the locale.
transitiveClosure<T>(Map<T, Iterable<T>> graph) → Map<T, Set<T>>
Returns the transitive closure of graph.
unawaited(Future<void>? future) → void
Explicitly ignores a future.
updateLocale(Locale locale) → void
urlFix(String url) → String
Takes an URL in http/s , ws/s as String and fix the Persian characters in it
validateCardNumber(String cardNumber) → bool
Checks validation of the given ATM card number
verifyIranianNationalId(String value) → bool
Checks the given String is an iranian national ID or not
wordsToNumber(String words) → int?
Returns equivalent number in int of the given words
wordsToNumberString(String words, {DigitLocale digits = DigitLocale.en, bool addComma = false}) → String?
Returns equivalent number in String of the given words.

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
BindingBuilderCallback = void Function()
Condition = bool Function()
ControllerCallback = void Function()
Type of a stream controller's onListen, onPause and onResume callbacks.
ControllerCancelCallback = FutureOr<void> Function()
Type of stream controller onCancel callbacks.
CreatePeriodicTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer))
The type of a custom Zone.createPeriodicTimer implementation function.
CreateTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f())
The type of a custom Zone.createTimer implementation function.
CropperDialogBuilder = Dialog Function(Widget cropper, Future<String?> crop(), void rotate(RotationAngle))
CropperRouteBuilder = PageRoute<String> Function(Widget cropper, Future<String?> crop(), void rotate(RotationAngle))
Decoder<T> = T Function(dynamic data)
DidReceiveBackgroundNotificationResponseCallback = void Function(NotificationResponse details)
Signature of callback triggered on background isolate when a user taps on a notification or a notification action.
DidReceiveLocalNotificationCallback = void Function(int id, String? title, String? body, String? payload)
Signature of the callback that is triggered when a notification is shown whilst the app is in the foreground.
DidReceiveNotificationResponseCallback = void Function(NotificationResponse details)
Signature of callback triggered on main isolate when a user taps on a notification or a notification action.
ErrorCallbackHandler = AsyncError? Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace? stackTrace)
The type of a custom Zone.errorCallback implementation function.
ExtendedIndexedWidgetBuilder = Widget Function(BuildContext context, int index, int realIndex)
ForkHandler = Zone Function(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification? specification, Map<Object?, Object?>? zoneValues)
The type of a custom Zone.fork implementation function.
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GroupButtonIndexedBuilder = Widget Function(bool selected, int index, BuildContext context)
Custom builder method to create custom buttons by index
GroupButtonIndexedTextBuilder = String Function(bool selected, int index, BuildContext context)
Custom builder method to create custom buttons by index
GroupbuttonTextBuilder<T> = String Function(bool selected, T value, BuildContext context)
Custom builder method to create custom buttons by value
GroupButtonValueBuilder<T> = Widget Function(bool selected, T value, BuildContext context)
Custom builder method to create custom buttons by value
HandleUncaughtErrorHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace)
The type of a custom Zone.handleUncaughtError implementation function.
InjectorBuilderCallback<S> = S Function(GetInstance)
InstanceBuilderCallback<S> = S Function()
KeyCallback = dynamic Function(String)
LogCallback = void Function(LogEvent event)
LogWriterCallback = void Function(String text, {bool isError})
VoidCallback from logs
NotifierBuilder<T> = Widget Function(T state)
OnTap = void Function(GetSnackBar snack)
OutputCallback = void Function(OutputEvent event)
PathBuilder = Path Function(Size)
PlateHandler = PlateInfo Function(NormalizedPlate)
Plate handler functions typedef
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
PrintHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, String line)
The type of a custom Zone.print implementation function.
Progress = dynamic Function(double percent)
RegisterBinaryCallbackHandler = ZoneBinaryCallback<R, T1, T2> Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2))
The type of a custom Zone.registerBinaryCallback implementation function.
RegisterCallbackHandler = ZoneCallback<R> Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.registerCallback implementation function.
RegisterUnaryCallbackHandler = ZoneUnaryCallback<R, T> Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg))
The type of a custom Zone.registerUnaryCallback implementation function.
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
RunBinaryHandler = R Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2)
The type of a custom Zone.runBinary implementation function.
RunHandler = R Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.run implementation function.
RunUnaryHandler = R Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg)
The type of a custom Zone.runUnary implementation function.
ScheduleMicrotaskHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, void f())
The type of a custom Zone.scheduleMicrotask implementation function.
SnackbarStatusCallback = void Function(SnackbarStatus? status)
StorageFactory = GetStorage Function()
UiTextDirection = TextDirection
ValueBuilderBuilder<T> = Widget Function(T snapshot, ValueBuilderUpdateCallback<T> updater)
ValueBuilderUpdateCallback<T> = void Function(T snapshot)
ValueUpdater<T> = T Function()
WidgetCallback = Widget Function()
WorkerCallback<T> = dynamic Function(T callback)
ZoneBinaryCallback<R, T1, T2> = R Function(T1, T2)
ZoneCallback<R> = R Function()
ZoneUnaryCallback<R, T> = R Function(T)

Exceptions / Errors

AsyncError
An error and a stack trace.
DeferredLoadException
Thrown when a deferred library fails to load.
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.
ParallelWaitError<V, E>
Error thrown when waiting for multiple futures, when some have errors.
PlayerException
Captures the details of any error accessing, loading or playing an audio source, including an invalid or inaccessible URL, or an audio encoding that could not be understood.
PlayerInterruptedException
An error that occurs when one operation on the player has been interrupted (e.g. by another simultaneous operation).
TimeoutException
Thrown when a scheduled timeout happens while waiting for an async result.