rtbase library

RtBase - A comprehensive Flutter base package providing essential utilities and widgets.

This library exports all core components of the rtbase package, including:

Third-party Packages:

  • auto_size_text: Automatically sized text widgets
  • cached_network_image: Efficient image caching
  • carousel_slider: Carousel/slider widgets
  • connectivity_plus: Network connectivity monitoring
  • crypto: Cryptographic functions (MD5, SHA)
  • faker: Generate fake data for testing
  • feedback: User feedback collection
  • flutter_image_compress: Image compression utilities
  • fluttertoast: Toast notifications
  • gap: Spacing widgets
  • get: State management and navigation (GetX)
  • get_storage: Fast local storage
  • image_picker: Camera/gallery image selection
  • intl: Internationalization and date formatting
  • path_provider: Platform-specific directory paths
  • permission_handler: Runtime permissions
  • readmore: Expandable text widgets
  • rt_api: API integration utilities
  • rt_awesome_snackbar_content: Styled snackbars

Core Components:

Models:

Widgets:

Import this library to access all rtbase functionality:

import 'package:rtbase/rtbase.dart';

Classes

Address
AddressComponent
Component of a place's address (e.g., street, city, postal code).
AmMessages
Amharic Messages
AmShortMessages
Amharic short Messages
Annotation
Defines a customizable pattern within text, such as hashtags, URLs, or mentions.
ApiError
ApiService ApiError Model
ApiHandler
ApiService inClass Handler
ApiService<R>
Api Service RulTech Architecture https://gitlab.rultech.in/-/snippets/4
ApiSuccess<T>
ApiService ApiSuccess Model
ApiType
ArFeedbackLocalizations
Default arabic localization
ArMessages
Arabic Messages
ArShortMessages
Arabic short Messages
AssetsPath
path to various SVGs being used from assets folder
AutoSizeGroup
Controller to synchronize the fontSize of multiple AutoSizeTexts.
AutoSizeText
Flutter widget that automatically resizes text to fit perfectly within its bounds.
AwesomeSnackbarContent
AzMessages
Azeri Messages
AzShortMessages
Azeri short Messages
BaseBinding
Base binding class for GetX dependency injection.
BeMessages
Belarusian messages (code based by russian and ukrainian translations)
BeShortMessages
BetterFeedback
A feedback widget that uses a custom widget and data type for prompting the user for their feedback. This widget should be the root of your widget tree. Specifically, it should be above any Navigator widgets, including the navigator provided by MaterialApp.
BgFeedbackLocalizations
Default bulgarian localization
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.
BnFeedbackLocalizations
Default bangla localization
BnMessages
English Messages
BnShortMessages
English short Messages
BrowserConfiguration
Additional configuration options for LaunchMode.inAppBrowserView
BsMessages
Bosnian Messages
BsShortMessages
Bosnian short Messages
CachedNetworkImage
Image widget to show NetworkImage with caching functionality.
CachedNetworkImageProvider
IO implementation of the CachedNetworkImageProvider; the ImageProvider to load network images using a cache.
CaMessages
Catalan Messages
CapitalizeFirstLetterFormatter
A text input formatter that capitalizes the first letter of the input.
CarouselOptions
CarouselSlider
CarouselSliderController
CarouselSliderControllerImpl
CarouselSliderState
CaShortMessages
Catalan short Messages
ChangeServerDialog
A dialog widget for changing the server/API base URL.
Close
Closing time information for a place.
Color
Company
Conference
Connectivity
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
ConnectivityPlusLinuxPlugin
The Linux implementation of ConnectivityPlatform.
ContentType
to handle failure, success, help and warning ContentType class is being used
CrossFileTestOverrides
Overrides some functions of CrossFile for testing purposes
CsMessages
Czech Messages
CsShortMessages
Czech short Messages
Currency
CurrentOpeningHours
Current opening hours information for a place.
CustomTransition
DaMessages
Danish Messages
DaShortMessages
Danish short Messages
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner.
DefaultAppThemeColoredButton
A customizable button widget that uses the app's theme colors.
DefaultAppThemeColoredButtonConst
Constants for the DefaultAppThemeColoredButton widget.
DefaultButton
A customizable default button widget with consistent styling across the application.
DefaultColors
DefaultColors incase color paramter is null in ContentType
DefaultDropdown
A customizable dropdown form field widget with app theme styling.
DefaultLoremDataProvider
DefaultSmallButton
A compact button widget with fixed small width.
DefaultSwitch
A customizable switch widget with label text and bordered container.
DefaultTextField
A customizable text field widget with search, password, and accessibility features.
DeFeedbackLocalizations
Default german localization
DeMessages
German Messages
DeShortMessages
German short Messages
Digest
A message digest as computed by a Hash or HMAC function.
DisposableInterface
DownloadProgress
Progress of the file that is being downloaded from the originalUrl.
DvMessages
Divehi Messages
DvShortMessages
Divehi short Messages
EasyImageView
An interactive image viewer widget with zoom and pan capabilities.
ElFeedbackLocalizations
Default greek localization
EnFeedbackLocalizations
Default english localization
EnMessages
English Messages
EnShortMessages
English short Messages
EsFeedbackLocalizations
Default spanish localization
EsMessages
Spanish Messages
EsShortMessages
Spanish short Messages
EtMessages
Estonian Messages
EtShortMessages
Estonian short Messages
FaFeedbackLocalizations
Default persian localization
Faker
FakerDataProvider
FakerDataProviderFa
FaMessages
Farsi Messages
FastList<T>
FeedbackController
Controls the state of the feeback ui.
FeedbackLocalizations
This class must be extended by all custom translations.
FeedbackSheetDragHandle
A drag handle to be placed at the top of a draggable feedback sheet.
FeedbackThemeData
See the following image to get a better understanding of the properties. Theme
FiMessages
Finnish Messages
FiShortMessages
Finnish short Messages
FlutterImageCompress
Image Compress plugin.
FlutterImageCompressPlatform
FlutterImageCompressValidator
Fluttertoast
Plugin to show a toast message on screen Only for android, ios and Web platforms
Food
FormData
FrFeedbackLocalizations
Default french localization
FrMessages
French messages
FrShortMessages
French shott messages
FToast
Runs on dart side this has no interaction with the Native Side Works with all platforms just in two lines of code final fToast = FToast().init(context) fToast.showToast(child)
FullLifeCycleController
FullScreenImage
A fullscreen image viewer widget with zoom and pan capabilities.
Gap
A widget that takes a fixed amount of space in the direction of its parent.
Geometry
Geographic location and viewport information for a place.
GetBar
GetBuilder<T extends GetxController>
GetBuilderState<T extends GetxController>
GetButtonDesign
A styled button widget used within the ChangeServerDialog.
GetConnect
GetConnectHelper
ApiService Helper extending 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
GetStorageManager
Singleton manager for GetStorage local storage operations.
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>
GlobalBottomSheet
Global utility class for displaying modal bottom sheets with consistent styling.
GlobalFeedbackLocalizationsDelegate
This is a localization delegate, which includes all of the localizations already present in this library.
GraphQLResponse<T>
GrMessages
Greek messages
GrShortMessages
Greek short messages
Guid
Hash
An interface for cryptographic hash functions.
HeaderValue
HeFeedbackLocalizations
Default Henrew localization
HeMessages
Hebrew Messages
HeShortMessages
Hebrew short Messages
HiMessages
Hindi Messages
HiShortMessages
Hindi short Messages
Hmac
An implementation of keyed-hash method authentication codes.
HorizontalWeekCalendar
Horizontal scrollable week calendar with date selection.
HrMessages
Croatian messages
HuMessages
Hungarian Messages
HuShortMessages
Hungarian short Messages
IdMessages
Indonesian messages
IdShortMessages
Indonesian short Messages
Image
ImagePicker
Provides an easy way to pick an image/video from the image library, or to take a picture/video with the camera.
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.
Internet
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.
ItMessages
Italian messages
ItShortMessages
Italian short messages
JaFeedbackLocalizations
Default japanese localization
JaMessages
Japanese messages
Job
Jwt
KmMessages
Cambodian messages
KmShortMessages
Cambodian short messages
KoMessages
Korean messages
KuMessages
Kurdish messages
KuShortMessages
Kurdish short messages
LightSubscription<T>
LinearProgressWidget
A customizable linear progress indicator widget with rounded edges.
Location
Geographic coordinates (latitude and longitude).
LookupMessages
LookupMessages template for any language
LoremDataProvider
LoremDataProviderFa
LostData
The response object of ImagePicker.retrieveLostData.
LostDataResponse
The response object of ImagePicker.getLostData.
LvMessages
Russian messages
LvShortMessages
MatchedSubstring
Represents a substring in the prediction that matches the user's input.
MaxGap
A widget that takes, at most, an amount of space in a Row, Column, or Flex widget.
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>
MnMessages
Mongolian Messages
MnShortMessages
Mongolian short Messages
MsMyMessages
Malay-Malaysia messages
MsMyShortMessages
Malay-Malaysia short messages
MultiImageStreamCompleter
An ImageStreamCompleter with support for loading multiple images.
MultipartFile
MyMessages
Myanmar Messages မြန်မာစာ
MyShortMessages
Myanmar short Messages
NbNoMessages
Norwegian-Bokm-Norway messages
NbNoShortMessages
Norwegian-Bokm-Norway short messages
NlMessages
Dutch messages
NlShortMessages
Dutch short messages
NnNoMessages
Norwegian-Nynorsk-Norway messgages
NnNoShortMessages
Norwegian-Nynorsk-Norway short messgages
Node<T>
NumberFormat
Provides the ability to format a number in a locale-specific way.
NumberParserBase<R>
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
Open
Opening time information for a place.
OpeningHours
Opening hours information for a place.
PageRedirect
PathDecoded
Period
Opening/closing time period for a specific day.
Permission
Defines the permissions which can be checked and requested.
PermissionService
Service class for managing runtime permissions across Android and iOS platforms.
PermissionWithService
A special kind of permission, used to access a service.
Person
Photo
Photo information for a place.
PickedFile
A PickedFile is a cross-platform, simplified File abstraction.
PlaceAutoComplete
Data model representing the response from Google Places Autocomplete API.
PlaceDetail
Data model representing detailed information about a place from Google Places API.
PlFeedbackLocalizations
Default polish localization
PlMessages
Polish messgages
PlusCode
Plus Code location identifier.
Prediction
Data model representing a single place prediction from Google Places Autocomplete API.
PtBrMessages
Portuguese-Brazil messages
PtBrShortMessages
Portuguese-Brazil short messages
PtFeedbackLocalizations
Default portuguese localization
RandomGenerator
ReadMoreText
ReadMoreTextState
ReadWriteValue<T>
Response<T>
ResponsiveScreen
ResponsiveScreenSettings
Result
Comprehensive place information from Google Places Details API.
Review
User review for a place.
RoMessages
Romanian messages
RoShortMessages
Romanian short messages
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
RtAppConstants
Application-wide constants for UI styling, sizing, and configuration.
RtAppFontFamily
Application-wide font family names and font size constants.
RtBaseController
Abstract base controller providing common functionality for GetX controllers.
RtBaseView<T extends RtBaseController>
Abstract base view class for creating screens with GetX architecture.
RtCommonFunction
A comprehensive utility class providing common functions used throughout the application.
RtCommonValidation
Common validation constants and rules used throughout the application.
RtCommonWidget
A comprehensive utility class providing reusable UI widgets and components for Flutter applications.
RtDeepLinking
A singleton service for handling deep linking in Flutter applications.
RtGetMaterialApp
Extended GetMaterialApp with built-in deep linking support.
RuFeedbackLocalizations
Default russian localization
RuMessages
Russian messages
RuShortMessages
RwMessages
Kinyarwanda Messages
RwShortMessages
Kinyarwanda short Messages
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.
Share
ShareParams
SharePlus
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.
ShortMessages
Urdu short Messages
SimpleBuilder
SimpleBuilderState
SliverGap
A sliver that takes a fixed amount of space.
SnackbarController
Sport
SrMessages
Serbian Messages
SrShortMessages
Serbian short Messages
StructuredFormatting
Structured breakdown of a place prediction into main and secondary text.
SuperController<T>
SvFeedbackLocalizations
Default swedish localization
SvMessages
Swedish messages
SvShortMessages
Swedish Short messages
TaMessages
Tamil messages
Term
Represents an individual term/word in a place prediction.
TextDirection
Represents directionality of text.
ThMessages
Thai messages
ThShortMessages
Thai short messages
TkMessages
Turkish messages
ToastStateFulState
State for _ToastStateFul
Translations
TrFeedbackLocalizations
Default turkish localization
TrianglePainter
A custom painter that draws triangular shapes on a canvas.
TrMessages
Turkish messages
TrShortMessages
Turkish short Messages
TrustedCertificate
UkFeedbackLocalizations
Default ukrainian localization
UkMessages
Ukrainian messages
UkShortMessages
UnsupportedFlutterImageCompress
UrMessages
Urdu Messages
UserFeedback
Container for the feedback of the user.
Utils
Central utility class providing convenient access to commonly used services and helpers.
Uuid
uuid for Dart Author: Yulian Kuncheff Released under MIT License.
UuidValue
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
ValueStorage<T>
Vehicle
Viewport
Recommended viewport for displaying a location on a map.
ViMessages
Vietnamese messages
ViShortMessages
Vietnamese short messages
WebViewConfiguration
Additional configuration options for LaunchMode.inAppWebView.
Worker
Workers
XFile
A CrossFile is a cross-platform, simplified File abstraction.
ZhCnMessages
Chinese-China messages
ZhFeedbackLocalizations
Default Simplified Chinese localization
ZhMessages
Chinese messages

Enums

CacheManagerLogLevel
Log levels of the cache manager. Debug shows failed downloads and verbose also shows successful downloads and cache retrievals.
CameraDevice
Which camera to use when picking images/videos while source is ImageSource.camera.
CarouselPageChangedReason
Casing
CenterPageEnlargeStrategy
CompressFormat
ConnectivityResult
Connection status check result.
CupertinoActivityType
Represents iOS-supported share activity types, such as AirDrop, Messages, Mail, and others.
FeedbackMode
Available modes of the feedback ui.
Format
ImageFormat
ImageSource
Specifies the source where the picked image should come from.
LaunchMode
The desired mode to launch a URL.
Namespace
RFC4122 & RFC9562 provided namespaces for v3, v5, and v8 namespace based UUIDs
PermissionStatus
Defines the state of a Permission.
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
RetrieveType
The type of the retrieved data in a LostDataResponse.
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.
Toast
Toast Length Only for Android Platform
ToastGravity
ToastGravity Used to define the position of the Toast on the screen
Transition
TrimMode
ValidationMode
The options for UUID Validation strictness
WeekStartFrom
Defines the first day of the week for calendar display.

Mixins

AppString
BottomSheetHeaderConst
Mixin providing bottom sheet header styling constants.
ClassApiHandler
ApiService ClassHandler
CommonSearchTextFieldConst
Mixin providing search text field styling constants.
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
NoItemFoundConst
Mixin providing empty state ("no items found") UI constants.
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.
SizeBoxMargin
Mixin providing spacing and margin constants.
SplashScreenVar
Mixin providing splash screen configuration constants.
StateMixin<T>

Extensions

BoolExtension on bool
ContextExtensionss on BuildContext
Data on T
DoubleExtension on double
ExtensionBottomSheet on GetInterface
ExtensionDialog on GetInterface
ExtensionSnackbar on GetInterface
FirstWhereExt on List<T>
FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
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
IterableExtensions on Iterable<T>
ListExtension on List<E>
LocalesIntl on GetInterface
LoopEventsExt on GetInterface
MapExtension on Map<K, V>
OverlayExt on GetInterface
PagesListExt on List<GetPage>
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.
Precision on double
ReactiveT on T
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>
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
Trans on String
WidgetMarginX on Widget
Add margin property to widget
WidgetPaddingX on Widget
add Padding Property to widget
WidgetSliverBoxX on Widget
Allows you to insert widgets inside a CustomScrollView

Constants

citySuffixes → const List<String>
codeNoInternet → const int
codePerformLogoutOnTokenExpires → const int
codePerformValidStatusCode → const int
codeResponseNull → const int
codeTimeOut → const int
codeUnknown → const int
conferenceNames → const List<String>
countries → const List<String>
countryCodes → const List<String>
cuisines → const List<String>
currencyCodes → const List<String>
currencyNames → const List<String>
dishes → const List<String>
firstnames → const List<String>
jobAdj → const List<String>
jobNoun → const List<String>
jobPrefix → const List<String>
kTypeImage → const String
Denotes that an image is being picked.
kTypeVideo → const String
Denotes that a video is being picked.
lastnames → const List<String>
md5 → const Hash
An implementation of the MD5 hash function.
neighborhoods → const List<String>
restaurants → const List<String>
rtlLanguages → const List<String>
sha1 → const Hash
An implementation of the SHA-1 hash function.
sha224 → const Hash
An implementation of the SHA-224 hash function.
sha256 → const Hash
An implementation of the SHA-256 hash function.
sha384 → const Hash
An implementation of the SHA-384 hash function.
sha512 → const Hash
An implementation of the SHA-512 hash function.
sha512224 → const Hash
An implementation of the SHA-512/224 hash function.
sha512256 → const Hash
An implementation of the SHA-512/256 hash function.
sportNames → const List<String>
streetSuffixes → const List<String>

Properties

accessDenied String
Invalid credentials error message.
getter/setter pair
activities String
Activities section title.
getter/setter pair
activitySubHeader String
Activity empty state sub-header.
getter/setter pair
apiKey String
API key storage key.
getter/setter pair
apiKeyError String
API key validation error.
getter/setter pair
apiKeyHint String
API key input hint text.
getter/setter pair
apiTimeoutToast String
API timeout error message displayed when request exceeds timeout threshold.
getter/setter pair
baseUrl String
Base URL storage key.
getter/setter pair
buttonLogin String
Login button text.
getter/setter pair
changeServer String
Change server dialog title.
getter/setter pair
couldNotSave String
Invalid URL validation error.
getter/setter pair
customFields String
Custom fields data storage key.
getter/setter pair
disablePathProviderPlatformOverride bool
no getter
doNotHaveAccount String
Account creation prompt.
getter/setter pair
email String
Email input field label.
getter/setter pair
enterEmailNote String
Email entry instruction for password reset.
getter/setter pair
error String
Generic error label.
getter/setter pair
estimated String
Estimated time label prefix.
getter/setter pair
faker Faker
final
filterList String
Filter list storage key.
getter/setter pair
forgotPassword String
Forgot password link text.
getter/setter pair
Get → _GetImpl
final
API request header storage key.
getter/setter pair
hoursSpent String
Hours spent label.
getter/setter pair
hoursSpentToday String
Hours spent today label.
getter/setter pair
invalidCredentialError String
Invalid credentials detailed error.
getter/setter pair
isLoggedIn String
User logged-in state storage key.
getter/setter pair
issueStatus String
Issue status data storage key.
getter/setter pair
loginError String
Login failure generic error.
getter/setter pair
loginTitle String
Login screen title.
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
noActivity String
No activity empty state.
getter/setter pair
noProject String
No projects empty state.
getter/setter pair
noResult String
No results found message.
getter/setter pair
noRunningTracker String
No active tracker message.
getter/setter pair
noTask String
No tasks empty state.
getter/setter pair
password String
Password input field label.
getter/setter pair
passwordError String
Password validation error.
getter/setter pair
performance String
Performance section title.
getter/setter pair
priority String
Priority data storage key.
getter/setter pair
projectSubHeader String
Project empty state sub-header.
getter/setter pair
random RandomGenerator
final
register String
Registration button/link text.
getter/setter pair
rememberMe String
Remember me checkbox label.
getter/setter pair
resetPasswordTitle String
Reset password screen title.
getter/setter pair
rultechBaseURL String
Default/production base URL.
getter/setter pair
runningTracker String
Running tracker label prefix.
getter/setter pair
searchHint String
Search input placeholder.
getter/setter pair
searchLimit String
Search character limit message.
getter/setter pair
searchSubHeader String
Search empty state instruction.
getter/setter pair
Send reset link button text.
getter/setter pair
serverHint String
Server URL input hint.
getter/setter pair
signIn String
Sign in button text.
getter/setter pair
signInUsingAPIKey String
API key sign-in option label.
getter/setter pair
signInUsingUserNamePassword String
Username/password sign-in option label.
getter/setter pair
signUp String
Sign up link text.
getter/setter pair
spent String
Time spent label prefix.
getter/setter pair
strLoadingText String
Centralized string constants for UI labels, messages, and storage keys.
getter/setter pair
subTextOfChangeServer String
Server change confirmation message.
getter/setter pair
taskSubHeader String
Task empty state sub-header.
getter/setter pair
timeDilation double
Slows down animations by this factor to help in development.
no setter
toastErrorCodeShow String
Generic error code display toast (use with String.format).
getter/setter pair
toastErrorOccurred String
Generic error message toast (use with String.format).
getter/setter pair
toastSessionExpired String
Session expiration toast message shown when user's session expires.
getter/setter pair
totalCount String
Total count label prefix.
getter/setter pair
trackers String
Trackers data storage key.
getter/setter pair
userInfo String
User information storage key.
getter/setter pair
userName String
Username input field label.
getter/setter pair
usernameError String
Username validation error.
getter/setter pair
validDeviceIdRequired String
Device ID validation error message.
getter/setter pair
youAreNotConnectedToInternet String
No internet connection error.
getter/setter pair
zeroHour String
Zero hours display text.
getter/setter pair

Functions

acmoConvertToUrduNumbers(int input) String
ambiguate<T>(T? value) → T?
bodyBytesToString(Stream<List<int>> bodyBytes, Map<String, String> headers) Future<String>
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.
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.
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
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.
format(DateTime date, {String? locale, DateTime? clock, bool allowFromNow = false}) String
Formats provided date to a fuzzy time like 'a moment ago'
FToastBuilder() TransitionBuilder
Simple builder method to create a TransitionBuilder and for the use in MaterialApp builder method
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.
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.
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.
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).
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.
launchUrl(Uri url, {LaunchMode mode = LaunchMode.platformDefault, WebViewConfiguration webViewConfiguration = const WebViewConfiguration(), BrowserConfiguration browserConfiguration = const BrowserConfiguration(), String? webOnlyWindowName}) Future<bool>
Passes url to the underlying platform for handling.
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.
setDefaultLocale(String locale) → void
Sets the default locale. By default it is en.
setLocaleMessages(String locale, LookupMessages lookupMessages) → void
Sets a locale with the provided lookupMessages to be available when using the format function.
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.
toBeginningOfSentenceCase<T extends String?>(T input, [String? locale]) → T
Convert a string to beginning of sentence case, in a way appropriate to the locale.

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
BindingBuilderCallback = void Function()
Condition = bool Function()
Decoder<T> = T Function(dynamic data)
ExtendedIndexedWidgetBuilder = Widget Function(BuildContext context, int index, int realIndex)
FeedbackBuilder = Widget Function(BuildContext, OnSubmit , ScrollController?)
A function that returns a Widget that prompts the user for feedback and calls OnSubmit when the user wants to submit their feedback.
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
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()
KeyCallback = dynamic Function(String)
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
NetworkManagerClientFactory = NetworkManagerClient Function()
NotifierBuilder<T> = Widget Function(T state)
OnFeedbackCallback = FutureOr<void> Function(UserFeedback)
Function which gets called when the user submits his feedback. feedback is the user generated feedback. A string, by default. screenshot is a raw png encoded image. OnFeedbackCallback should cast feedback to the appropriate type.
OnSubmit = Future<void> Function(String feedback, {Map<String, dynamic>? extras})
The function to be called when the user submits his feedback.
OnTap = void Function(GetSnackBar snack)
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.
PositionedToastBuilder = Widget Function(BuildContext context, Widget child, ToastGravity? gravity)
Signature for a function to buildCustom Toast
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
Progress = dynamic Function(double percent)
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.
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
ResponseInterceptor<T> = Future<Response<T>?> Function(Request<T> request, Type targetType, HttpClientResponse response)
SnackbarStatusCallback = void Function(SnackbarStatus? status)
StorageFactory = GetStorage Function()
ToastPositionMapping = Widget? Function(Widget child, ToastGravity? gravity)
Signature for a function that defines custom position mapping for a toast
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)

Exceptions / Errors

CompressError
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.