fpj_cores
library
Classes
Badge
BadgeAnimation
BadgeGradient
BadgePosition
Utility class. Don't try to use it!
BadgePositioned
Utility class. Don't try to use it!
BadgeState
BadgeStyle
BaseAnimationBuilder
bezier + circle indicator,you can use this directly
bezier container,if you need to implements indicator with bezier ,you can use consider about use this
this will add the bezier container effect
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.
CachedNetworkImage
Image widget to show NetworkImage with caching functionality.
CachedNetworkImageProvider
IO implementation of the CachedNetworkImageProvider; the ImageProvider to
load network images using a cache.
ChRefreshString
Chinese
the most common indicator,combine with a text and a icon
the most common indicator,combine with a text and a icon
a custom Indicator for footer,the usage I have put in CustomHeader ,same with that
See also
a custom Indicator for header
CustomTransition
DateFormats
一些常用格式参照。可以自定义格式，例如：'yyyy/MM/dd HH:mm:ss'，'yyyy/M/d HH:mm:ss'。
格式要求
year -> yyyy/yy month -> MM/M day -> dd/d
hour -> HH/H minute -> mm/m second -> ss/s
DateUtil
Date Util.
DeRefreshString
German
DisposableInterface
DownloadProgress
Progress of the file that is being downloaded from the originalUrl.
EncodedImage
A description of an encoded image.
EncryptUtil
Encrypt Util.
EnInfo
EnNormalInfo
EnRefreshString
English
EsRefreshString
Spanish
FastList <T >
FontSizeResolvers
FormData
FpjController
FpjState <T extends StatefulWidget >
FpjUtil
FpjWidgetApp
FpjWidgetContainer
FpjWidgetImageNetwork
FpjWidgetImageSvg
FpjWidgetPage
FpjWidgetQrCode
FrRefreshString
French
FullLifeCycleController
Gap
A widget that takes a fixed amount of space in the direction of its parent.
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 >
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
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 >
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.
ItRefreshString
Italian
JpRefreshString
Japanese
JsonUtil
Json Util.
KrRefreshString
Korean
LightSubscription <T >
enable footer link other footer place outside the viewport
enable header link other header place outside the viewport
LoadIndicator
a widget implements pull up load
LoadIndicatorState <T extends LoadIndicator >
LoadingProcessor
footer Indicator exposure interface
LogUtil
Log Util.
mostly use flutter inner's RefreshIndicator
MaxGap
A widget that takes, at most, an amount of space in a Row , Column ,
or Flex widget.
MiddlewareRunner
MiniStream <T >
MiniSubscription <T >
MixinBuilder <T extends GetxController >
MoneyUtil
Money Util.
MultiImageStreamCompleter
An ImageStreamCompleter with support for loading multiple images.
MultipartFile
NlRefreshString
Dutch
Node <T >
NumUtil
Num Util.
ObjectUtil
Object Util.
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
OffsetAnimationBuilder
OKToast
OpacityAnimationBuilder
PaletteColor
A color palette color generated by the PaletteGenerator .
PaletteGenerator
A class to extract prominent colors from an image for use as user interface
colors.
PaletteTarget
A class which allows custom selection of colors when a PaletteGenerator is
generated.
PathDecoded
PtRefreshString
RebuildFactors
REdgeInsets
REdgeInsetsDirectional
RefreshConfiguration
Controls how SmartRefresher widgets behave in a subtree.the usage just like ScrollConfiguration
RefreshController
A controller controll header and footer state,
it can trigger driving request Refresh ,set the initalRefresh,status if needed
RefreshIndicator
a widget implements ios pull down refresh effect and Android material RefreshIndicator overScroll effect
RefreshIndicatorState <T extends RefreshIndicator >
Internal Implementation of Head Indicator
RefreshLocalizations
Implementation of localized strings for the ClassicHeader ,ClassicFooter ,TwoLevelHeader
RefreshLocalizationsDelegate
RefreshNotifier <T >
RefreshPhysics
a scrollPhysics for config refresh scroll effect,enable viewport out of edge whatever physics it is
in ClampingScrollPhysics , it doesn't allow to flip out of edge,but in RefreshPhysics,it will allow to do that,
by parent physics passing,it also can attach the different of iOS and Android different scroll effect
it also handles interception scrolling when refreshed, or when the second floor is open and closed.
with SpringDescription passing,you can custom spring back animate,the more paramter can be setting in RefreshConfiguration
RefreshProcessor
head Indicator exposure interface
RefreshString
interface implements different language
RegexUtil
Regex Util.
Response <T >
ResponsiveScreen
ResponsiveScreenSettings
RouterOutlet <TDelegate extends RouterDelegate <T > , T extends Object >
RouterOutletState <TDelegate extends RouterDelegate <T > , T extends Object >
Routing
RPadding
RSizedBox
RuRefreshString
Russian
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.
ScreenUtil
ScreenUtilInit
SimpleBuilder
SimpleBuilderState
SlideTween
SliverGap
A sliver that takes a fixed amount of space.
SmartRefresher
This is the most important component that provides drop-down refresh and up loading.
RefreshController must not be null,Only one controller to one SmartRefresher
SmartRefresherState
SnackbarController
SuperController <T >
SvRefreshString
Swedish
TextUtil
Text Util.
TimelineInfo
Timeline information configuration.
Timeline信息配置.
TimelineUtil
TimelineUtil
TimerUtil
TimerUtil.
ToastFuture
Use the dismiss to dismiss toast.
ToastPosition
Translations
TrustedCertificate
this header help you implements twoLevel function easyily,
the behaviour just like TaoBao,XieCheng(携程) App TwoLevel
UkRefreshString
Value <T >
ValueBuilder <T >
Manages a local state like ObxValue, but uses a callback instead of
a Rx value.
ValueBuilderState <T >
QQ ios refresh header effect
attach the waterdrop effect to MaterialClassicHeader
Worker
Workers
ZhInfo
ZhNormalInfo
Enums
BadgeAnimationType
This is a set of animations that you can use for your badges.Badge widget.
Do not use them explicitly, use for example BadgeAnimation.slide() instead.
BadgeShape
Set of shapes that you can use for your badges.Badge widget.
BezierCircleType
BezierDismissType
CacheManagerLogLevel
Log levels of the cache manager. Debug shows failed downloads and verbose
also shows successful downloads and cache retrievals.
DayFormat
(xx)Configurable output.
(xx)为可配置输出.
DeviceType
IconPosition
direction that icon should place to the text
LoadStatus
footer state
LoadStyle
footer indicator display style
MoneyFormat
MoneyUnit
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
RefreshStatus
header state
RefreshStyle
header indicator display style
RowStyle
ScreenType
SmartManagement
GetX by default disposes unused controllers from memory,
Through different behaviors.
SmartManagement.full
SmartManagement.full is the default one. Dispose classes that are
not being used and were not set to be permanent. In the majority
of the cases you will want to keep this config untouched.
If you new to GetX then don't change this.
SmartManagement.onlyBuilder only controllers started in init:
or loaded into a Binding with Get.lazyPut() will be disposed. If you use
Get.put() or Get.putAsync() or any other approach, SmartManagement
will not have permissions to exclude this dependency. With the default
behavior, even widgets instantiated with "Get.put" will be removed,
unlike SmartManagement.onlyBuilders.
SmartManagement.keepFactory Just like SmartManagement.full,
it will remove it's dependencies when it's not being used anymore.
However, it will keep their factory, which means it will recreate
the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar
SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar
has closed,
SnackbarStatus.OPENING Starts with the opening animation and ends
with the full
snackbar display, SnackbarStatus.CLOSING Starts with the closing animation
and ends
with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
StorageDirectory
Corresponds to constants defined in Androids android.os.Environment class.
Transition
TwoLevelDisplayAlignment
Functions
ambiguate <T > (T? value → T?
avoidRedBlackWhitePaletteFilter (HSLColor color → bool
A basic PaletteFilter , which rejects colors near black, white and low
saturation red.
bodyBytesToString (Stream <List <int bodyBytes , Map <String String headers → Future <String
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
dismissAllToast ({bool showAnim = false → void
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.
fpjRunApp ({required Widget app , VoidCallback ?onInit , String configLocalKVName = "Storage" → Future
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).
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().
setLocaleInfo (String locale , TimelineInfo timelineInfo → void
add custom configuration.
showToast (String msg , {BuildContext ?context , BuildContextPredicate buildContextPredicate = _defaultContextPredicate , Duration ?duration , ToastPosition ?position , Color ?backgroundColor , double ?radius , VoidCallback ?onDismiss , bool ?dismissOtherToast , OKToastAnimationBuilder ?animationBuilder , Duration ?animationDuration , Curve ?animationCurve , BoxConstraints ?constraints , EdgeInsetsGeometry ?margin = const EdgeInsets.all(50) , TextDirection ?textDirection , EdgeInsetsGeometry ?textPadding , TextAlign ?textAlign , TextStyle ?textStyle , int ?textMaxLines , TextOverflow ?textOverflow → ToastFuture
Show toast with msg,
showToastWidget (Widget widget , {BuildContext ?context , BuildContextPredicate buildContextPredicate = _defaultContextPredicate , Duration ?duration , ToastPosition ?position , VoidCallback ?onDismiss , bool ?dismissOtherToast , TextDirection ?textDirection , bool ?handleTouch , OKToastAnimationBuilder ?animationBuilder , Duration ?animationDuration , Curve ?animationCurve → ToastFuture
Show a widget and returns a ToastFuture .
Typedefs
AddSubscription T >
= FutureOr <void > Function(LightSubscription <T > subs
AsyncInstanceBuilderCallback S >
= Future <S > Function()
BindingBuilderCallback
= void Function()
ChainHandle
= bool Function()
create by : jie
2024/12/26
Condition
= bool Function()
Decoder T >
= T Function(dynamic data
FontSizeResolver
= double Function(num fontSize , ScreenUtil instance
custom footer builder,you can use second paramter to know what footerr state is
GesterTapImage
= dynamic Function(String imageUrl
GetControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
GetPageBuilder
= Widget Function()
GetXControllerBuilder T extends DisposableInterface >
= Widget Function(T controller
custom header builder,you can use second paramter to know what header state is
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.
IndicatorBuilder
= Widget Function()
global default indicator builder
InjectorBuilderCallback S >
= S Function(GetInstance
InstanceBuilderCallback S >
= S Function()
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
ModeChangeCallBack T >
= void Function(T? mode
NotifierBuilder T >
= Widget Function(T state
OffsetCallBack
= void Function(double offset
OKToastAnimationBuilder
= Widget Function(BuildContext context , Widget child , AnimationController controller , double percent
OnTap
= void Function(GetSnackBar snack
OnTimerTickCallback
= void Function(int millisUntilFinished
timer callback.(millisUntilFinished 毫秒).
OnTwoLevel
= void Function(bool isOpen
when viewport not full one page, for different state,whether it should follow the content
OuterBuilder
= Widget Function(Widget child
wrap child in outside,mostly use in add background color and padding
PaletteFilter
= bool Function(HSLColor color
Hook to allow clients to be able filter colors from selected in a
PaletteGenerator . Returns true if the color is allowed.
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.
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.
RebuildFactor
= bool Function(MediaQueryData old , MediaQueryData data
RefresherBuilder
= Widget Function(BuildContext context , RefreshPhysics physics
a builder for attaching refresh function with the physics
RemoveSubscription T >
= FutureOr <bool ? Function(LightSubscription <T > subs
ResponseInterceptor T >
= Future <Response <T > ? Function(Request<T > request , Type targetType , HttpClientResponse response
ScreenUtilInitBuilder
= Widget Function(BuildContext context , Widget ?child
ShouldFollowContent
= bool Function(LoadStatus ?status
when viewport not full one page, for different state,whether it should follow the content
SnackbarStatusCallback
= void Function(SnackbarStatus ?status
ValueBuilderBuilder T >
= Widget Function(T snapshot , ValueBuilderUpdateCallback <T > updater
ValueBuilderUpdateCallback T >
= void Function(T snapshot
ValueUpdater T >
= T Function()
VoidFutureCallBack
= Future <void > Function()
WidgetCallback
= Widget Function()
WorkerCallback T >
= dynamic Function(T callback
Exceptions / Errors
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on
the current platform cannot be obtained.
