v_base library

Classes

AlwaysAliveRefreshable<T>: An interface for provider expressions that can be passed to ref.refresh
AppDialog: @author:wzp_vicky @time：2022年11月3日14:48:11 @version: V2.0 @description 最早来自photoai项目，正式纳入框架是3.x框架创建。主要功能就是创建出类似退出登录的提示框这一版是修改部分属性。说明：使用时，类似重庆公运，退出的时候没有提示那个title，如果不需要的话，title可以传“”，这个时候title还有30的padding; 内容采取自定义的，给内容设置30的下边框，可使样式稍微顺眼点，后续如果对这个求精的话再改
AppException: 自定义异常
AsyncData<T>: Creates an AsyncValue with a data.
AsyncError<T>: Creates an AsyncValue in the error state.
AsyncLoading<T>: Creates an AsyncValue in loading state.
AsyncNotifier<State>: A Notifier implementation that is asynchronously initialized.
AsyncNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>: The element of AsyncNotifierProvider.
AsyncNotifierProviderElementBase<NotifierT extends AsyncNotifierBase<T>, T>: The element of AsyncNotifierProvider.
AsyncNotifierProviderFamily<NotifierT extends FamilyAsyncNotifier<T, Arg>, T, Arg>: The Family of AsyncNotifierProvider.
AsyncNotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
AsyncValue<T>: A utility for safely manipulating asynchronous data.
AutoDisposeAsyncNotifier<State>: A provider which creates and listens to an AsyncNotifier.
AutoDisposeAsyncNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>: The element of AutoDisposeAsyncNotifierProvider.
AutoDisposeAsyncNotifierProviderFamily<NotifierT extends AutoDisposeFamilyAsyncNotifier<T, Arg>, T, Arg>: The Family of AsyncNotifierProvider.
AutoDisposeAsyncNotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeChangeNotifierProvider<NotifierT extends ChangeNotifier?>: Creates a ChangeNotifier and exposes its current state.
AutoDisposeChangeNotifierProviderElement<NotifierT extends ChangeNotifier?>: The element of AutoDisposeChangeNotifierProvider.
AutoDisposeChangeNotifierProviderFamily<NotifierT extends ChangeNotifier?, Arg>: The Family of AutoDisposeChangeNotifierProvider.
AutoDisposeChangeNotifierProviderRef<NotifierT extends ChangeNotifier?>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeFamilyAsyncNotifier<State, Arg>: A provider which creates and listens to an AsyncNotifier.
AutoDisposeFamilyNotifier<State, Arg>: A class which exposes a state that can change over time.
AutoDisposeFamilyStreamNotifier<State, Arg>: A variant of AsyncNotifier which has build creating a Stream.
AutoDisposeFutureProvider<T>: A provider that asynchronously creates a value.
AutoDisposeFutureProviderElement<T>: The ProviderElementBase of AutoDisposeFutureProvider
AutoDisposeFutureProviderFamily<R, Arg>: The Family of an AutoDisposeFutureProvider
AutoDisposeFutureProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeNotifier<State>: A class which exposes a state that can change over time.
AutoDisposeNotifierProviderElement<NotifierT extends NotifierBase<T>, T>: The element of AutoDisposeNotifierProvider
AutoDisposeNotifierProviderFamily<NotifierT extends AutoDisposeFamilyNotifier<T, Arg>, T, Arg>: The Family of NotifierProvider.
AutoDisposeNotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeProvider<T>: A provider that exposes a read-only value.
AutoDisposeProviderElement<T>: The element of AutoDisposeProvider
AutoDisposeProviderFamily<R, Arg>: The Family of AutoDisposeProvider
AutoDisposeProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeRef<State>: A Ref for providers that are automatically destroyed when no longer used.
AutoDisposeStateNotifierProvider<NotifierT extends StateNotifier<T>, T>: Creates a StateNotifier and exposes its current state.
AutoDisposeStateNotifierProviderElement<NotifierT extends StateNotifier<T>, T>: The element of AutoDisposeStateNotifierProvider.
AutoDisposeStateNotifierProviderFamily<NotifierT extends StateNotifier<T>, T, Arg>: The Family of AutoDisposeStateNotifierProvider.
AutoDisposeStateNotifierProviderRef<NotifierT extends StateNotifier<T>, T>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeStateProvider<T>: A provider that exposes a value that can be modified from outside.
AutoDisposeStateProviderElement<T>: The element of StateProvider.
AutoDisposeStateProviderFamily<R, Arg>: The Family of StateProvider.
AutoDisposeStateProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeStreamNotifier<State>: A variant of AsyncNotifier which has build creating a Stream.
AutoDisposeStreamNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>: The element of AutoDisposeStreamNotifierProvider.
AutoDisposeStreamNotifierProviderFamily<NotifierT extends AutoDisposeFamilyStreamNotifier<T, Arg>, T, Arg>: The Family of StreamNotifierProvider.
AutoDisposeStreamNotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
AutoDisposeStreamProvider<T>: Creates a stream and exposes its latest event.
AutoDisposeStreamProviderElement<T>: The element of AutoDisposeStreamProvider.
AutoDisposeStreamProviderFamily<R, Arg>: The Family of AutoDisposeStreamProvider.
AutoDisposeStreamProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
BadRequestException: 请求错误
BasePage
ChangeNotifierProvider<NotifierT extends ChangeNotifier?>: Creates a ChangeNotifier and exposes its current state.
ChangeNotifierProviderElement<NotifierT extends ChangeNotifier?>: The element of ChangeNotifierProvider.
ChangeNotifierProviderFamily<NotifierT extends ChangeNotifier?, Arg>: The Family of ChangeNotifierProvider.
ChangeNotifierProviderRef<NotifierT extends ChangeNotifier?>: An object used by providers to interact with other providers and the life-cycles of the application.
ColorsUtil
CommonAppbarUtil
CommonBasePageState<T extends BasePage>
Consumer: Build a widget tree while listening to providers.
ConsumerState<T extends ConsumerStatefulWidget>: A State that has access to a WidgetRef through ref, allowing it to read providers.
ConsumerStatefulElement: The Element for a ConsumerStatefulWidget
ConsumerStatefulWidget: A StatefulWidget that can read providers.
ConsumerWidget: A StatelessWidget that can listen to providers.
DottedScaleXWidget
Family<@Deprecated('The generic parameter will be removed in version 3.0.0. ' 'This is to enable riverpod_generator to implement families with generic parameters') State>: A base class for all families
FamilyAsyncNotifier<State, Arg>: A Notifier implementation that is asynchronously initialized.
FamilyNotifier<State, Arg>: A class which exposes a state that can change over time.
FamilyStreamNotifier<State, Arg>: A variant of AsyncNotifier which has build creating a Stream.
FormData: A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FutureProvider<T>: A provider that asynchronously creates a value.
FutureProviderElement<T>: The element of a FutureProvider
FutureProviderFamily<R, Arg>: The Family of a FutureProvider
FutureProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
HttpDioConfig
KeepAliveLink: A object which maintains a provider alive.
LoadingConfig
Notifier<State>: A class which exposes a state that can change over time.
NotifierProviderElement<NotifierT extends NotifierBase<T>, T>: The element of NotifierProvider.
NotifierProviderFamily<NotifierT extends FamilyNotifier<T, Arg>, T, Arg>: The Family of NotifierProvider.
NotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
Override: An object used by ProviderContainer/ProviderScope to override the behavior of a provider/family for part of the application.
PageMixins
Permission: Defines the permissions which can be checked and requested.
PermissionsHelper
PermissionWithService: A special kind of permission, used to access a service.
Provider<State>: A provider that exposes a read-only value.
ProviderBase<StateT>: A base class for all providers.
ProviderContainer: An object that stores the state of the providers and allows overriding the behavior of a specific provider.
ProviderElement<State>: A provider that exposes a read-only value.
ProviderElementBase<StateT>: An internal class that handles the state of a provider.
ProviderFamily<R, Arg>: The Family of Provider
ProviderListenableOrFamily: A shared interface between ProviderListenable and Family.
ProviderObserver: An object that listens to the changes of a ProviderContainer.
ProviderOrFamily: A common interface shared by ProviderBase and Family
ProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
ProviderScope: A widget that stores the state of providers.
ProviderSubscription<State>: Represents the subscription to a ProviderListenable
Ref<@Deprecated('Will be removed in 3.0') State extends Object?>: An object used by providers to interact with other providers and the life-cycles of the application.
Refreshable<T>: An interface for provider expressions that can be passed to ref.refresh
ReponseConfig
ReponseConfigUtils
RingPainter
ScaleYWidget
SpinKitChasingDots
SpinKitCircle
SpinKitCubeGrid
SpinKitDancingSquare
SpinKitDoubleBounce
SpinKitDualRing
SpinKitFadingCircle
SpinKitFadingCube
SpinKitFadingFour
SpinKitFadingGrid
SpinKitFoldingCube
SpinKitHourGlass
SpinKitPianoWave
SpinKitPouringHourGlass
SpinKitPouringHourGlassRefined
SpinKitPulse
SpinKitPulsingGrid
SpinKitPumpCurve
SpinKitPumpingHeart
SpinKitRing
SpinKitRingCurve
SpinKitRipple
SpinKitRotatingCircle
SpinKitRotatingPlain
SpinKitSpinningCircle
SpinKitSpinningLines
SpinKitSquareCircle
SpinKitThreeBounce
SpinKitThreeInOut
SpinKitWanderingCubes
SpinKitWave
SpinkitWaveCustomPaint
SpinKitWaveSpinner
SpinningLinesPainter
StateController<T>: A StateNotifier that allows modifying its state from outside.
StateNotifier<T>: An observable class that stores a single immutable state.
StateNotifierProvider<NotifierT extends StateNotifier<T>, T>: Creates a StateNotifier and exposes its current state.
StateNotifierProviderElement<NotifierT extends StateNotifier<T>, T>: The element of StateNotifierProvider.
StateNotifierProviderFamily<NotifierT extends StateNotifier<T>, T, Arg>: The Family of StateNotifierProvider.
StateNotifierProviderRef<NotifierT extends StateNotifier<T>, T>: An object used by providers to interact with other providers and the life-cycles of the application.
StateProvider<T>: A provider that exposes a value that can be modified from outside.
StateProviderElement<T>: The element of StateProvider.
StateProviderFamily<R, Arg>: The Family of StateProvider.
StateProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
StreamNotifier<State>: A variant of AsyncNotifier which has build creating a Stream.
StreamNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>: The element of StreamNotifierProvider.
StreamNotifierProviderFamily<NotifierT extends FamilyStreamNotifier<T, Arg>, T, Arg>: The Family of StreamNotifierProvider.
StreamNotifierProviderRef<T>: An object used by providers to interact with other providers and the life-cycles of the application.
StreamProvider<T>: Creates a stream and exposes its latest event.
StreamProviderElement<T>: The element of StreamProvider.
StreamProviderFamily<R, Arg>: The Family of StreamProvider.
StreamProviderRef<State>: An object used by providers to interact with other providers and the life-cycles of the application.
TextStyleUtils
ToastUtils
UnauthorisedException: 未认证异常
UncontrolledProviderScope: Expose a ProviderContainer to the widget tree.
VBaseUtils: FileName base_utils
VBFPermissionHelper: FileName permission_request
VFBaseTextDelegate
VFEnglishTextDelegate
VFFrenchTextDelegate
VFHantTextDelegate
VFJapaneseTextDelegate
VFKoreanTextDelegate
VFTextDelegateHelper
VLog
WidgetRef: An object that allows widgets to interact with providers.

Enums

PermissionStatus: Defines the state of a Permission.
ServiceStatus: Defines the different states a service can be in.
SpinKitPianoWaveType
SpinKitWaveType

Mixins

AlwaysAliveProviderBase<State>: A base class for providers that never dispose themselves.
AlwaysAliveProviderListenable<State>: A base class for all providers, used to consume a provider.
OverrideWithValueMixin<State>: A mixin to add overrideWithValue capability to a provider.
ProviderListenable<State>: A base class for all providers, used to consume a provider.

Extensions

AsyncValueX on AsyncValue<T>: An extension that adds methods like when to an AsyncValue.
FuturePermissionStatusGetters on Future<PermissionStatus>: Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>: Utility getter extensions for the Future<ServiceStatus> type.
OverrideWithProviderExtension on ProviderType: A mixin to add overrideWithProvider capability to providers.
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.
ServicePermissionActions on PermissionWithService: Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus: Utility getter extensions for the ServiceStatus type.

Constants

DEFAULT_TOAST_COLOR → const Color
DEFAULT_TOAST_DURATION → const Duration

Properties

logger → Logger: final

Functions

convert2GetFormData(Map params, {String fileKey = "file"}) → FormData?: @author:wzp_vicky @time：2024年11月12日13:43:06 @version: V1 @description 针对上传file MultipartFile的场景如dio官方所述：https://github.com/cfug/dio/blob/main/dio/README-ZH.md#%E9%80%9A%E8%BF%87-formdata-%E4%B8%8A%E4%BC%A0%E5%A4%9A%E4%B8%AA%E6%96%87%E4%BB%B6 按照他的方法我们可以看见file的content-type和mimetype都是 ---> application/octet-stream 如果后端强制校验了：eg:图片是image/jpeg那直接使用dio官方的方式就不行了，所以这里做一个统一的处理请注意这个入口方法没有没有按照小程序的分成filePath和formData，考虑到分开可能需要new多个map就算了且小程序是单个上传我这个支持多个，就搞成这种吧
describeIdentity(Object? object) → String: Returns a summary of the runtime type and hash code of object.
openAppSettings() → Future<bool>: Opens the app settings page.
shortHash(Object? object) → String: Object.hashCode's 20 least-significant bits.

Typedefs

AsyncNotifierFamilyProvider<NotifierT extends FamilyAsyncNotifier<T, Arg>, T, Arg> = FamilyAsyncNotifierProviderImpl<NotifierT, T, Arg>: A provider which creates and listens to an AsyncNotifier.
AsyncNotifierProvider<NotifierT extends AsyncNotifier<T>, T> = AsyncNotifierProviderImpl<NotifierT, T>: A provider which creates and listens to an AsyncNotifier.
AutoDisposeAsyncNotifierProvider<NotifierT extends AutoDisposeAsyncNotifier<T>, T> = AutoDisposeAsyncNotifierProviderImpl<NotifierT, T>: A provider which creates and listens to an AsyncNotifier.
AutoDisposeFamilyAsyncNotifierProvider<NotifierT extends AutoDisposeFamilyAsyncNotifier<T, Arg>, T, Arg> = AutoDisposeFamilyAsyncNotifierProviderImpl<NotifierT, T, Arg>: A provider which creates and listens to an AsyncNotifier.
AutoDisposeFamilyNotifierProvider<NotifierT extends AutoDisposeFamilyNotifier<T, Arg>, T, Arg> = AutoDisposeFamilyNotifierProviderImpl<NotifierT, T, Arg>: A Provider which exposes a Notifier and listens to it.
AutoDisposeFamilyStreamNotifierProvider<NotifierT extends AutoDisposeFamilyStreamNotifier<T, Arg>, T, Arg> = AutoDisposeFamilyStreamNotifierProviderImpl<NotifierT, T, Arg>
AutoDisposeNotifierProvider<NotifierT extends AutoDisposeNotifier<T>, T> = AutoDisposeNotifierProviderImpl<NotifierT, T>: A Provider which exposes a Notifier and listens to it.
AutoDisposeStreamNotifierProvider<NotifierT extends AutoDisposeStreamNotifier<T>, T> = AutoDisposeStreamNotifierProviderImpl<NotifierT, T>
ConsumerBuilder = Widget Function(BuildContext context, WidgetRef ref, Widget? child): A function that can also listen to providers
ErrorListener = void Function(Object error, StackTrace? stackTrace): A callback that can be passed to StateNotifier.onError.
Locator = T Function<T>(): A function that allows obtaining other objects.
NotifierFamilyProvider<NotifierT extends FamilyNotifier<T, Arg>, T, Arg> = FamilyNotifierProviderImpl<NotifierT, T, Arg>: The provider for NotifierProviderFamily.
NotifierProvider<NotifierT extends Notifier<T>, T> = NotifierProviderImpl<NotifierT, T>: A Provider which exposes a Notifier and listens to it.
RemoveListener = void Function(): A callback that can be used to remove a listener added with StateNotifier.addListener.
StreamNotifierFamilyProvider<NotifierT extends FamilyStreamNotifier<T, Arg>, T, Arg> = FamilyStreamNotifierProviderImpl<NotifierT, T, Arg>: A variant of AsyncNotifier which has build creating a Stream.
StreamNotifierProvider<NotifierT extends StreamNotifier<T>, T> = StreamNotifierProviderImpl<NotifierT, T>: A variant of AsyncNotifier which has build creating a Stream.

Exceptions / Errors

CircularDependencyError: An error thrown when a call to Ref.read/Ref.watch leads to a provider depending on itself.
DependencyNotFoundException<T>: Thrown when tried to call LocatorMixin.read<T>(), but the T was not found.s
StateNotifierListenerError: An error thrown when trying to update the state of a StateNotifier, but at least one of the listeners threw.

Classes

Enums

Mixins

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

v_base_framework package

v_base library