nylo_framework library

The Nylo Framework - a micro-framework for Flutter.

Provides tools for building Flutter applications including routing, networking, themes, storage, CLI scaffolding, and more.

Classes

Accumulator

Mutable wrapper of an integer that can be passed by reference to track a value across a recursive stack.

ActiveNotification

Details of an active notification.

AlertTab

AlertTab is a class that holds the state, icon, initialCount, backgroundColor, textColor, smallSize, largeSize, textStyle, padding, alignment, offset, and isLabelVisible of an alert tab.

Alignment

A point within a rectangle.

AlignmentDirectional

An offset that's expressed as a fraction of a Size, but whose horizontal component is dependent on the writing direction.

AlignmentGeometry

Base class for Alignment that allows for text-direction aware resolution.

AndroidBitmap<T>

Represents a bitmap on Android.

AndroidFlutterLocalNotificationsPlugin

Android implementation of the local notifications plugin.

AndroidIcon<T>

Represents an icon on Android.

AndroidInitializationSettings

Plugin initialization settings for Android.

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.

AndroidNotificationConfig

Configuration options specific to Android notifications.

AndroidNotificationDetails

Contains notification details specific to Android.

AndroidNotificationSound

Represents an Android notification sound.

AnimatedButtonWrapper

A wrapper widget that applies animation effects to buttons. Wraps the button output rather than modifying individual button implementations.

AnimatedButtonWrapperState

ApiCallInfo

Public info about an API call for assertions.

ApiRequestLog

Represents a logged HTTP API request and its response.

AppBarColors

Color configuration for the app bar.

ArgumentsWrapper

AssetBundleImageKey

Key for the image obtained by an AssetImage or ExactAssetImage.

AssetBundleImageProvider

A subclass of ImageProvider that knows about AssetBundles.

AssetImage

Fetches an image from an AssetBundle, having determined the exact image to use based on the context.

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.

Auth

Authentication class for managing user sessions.

AutomaticNotchedShape

A NotchedShape created from ShapeBorders.

BackgroundTransformer

The default Transformer for Dio.

Backpack

Backpack class for storing data This class is not designed to store huge amounts of data.

BadgeTab

BadgeTab is a class that holds the state, icon, initialCount, backgroundColor, textColor, smallSize, largeSize, textStyle, padding, alignment, offset, and isLabelVisible of a badge tab.

BaseController

Nylo's base controller class

BaseOptions

A set of base settings for each Dio(). BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.

BaseThemeConfig<T>

Base theme config is used for theme management. Set the required parameters to create new themes.

BeveledRectangleBorder

A rectangular border with flattened or "beveled" corners.

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.

BitmapFilePathAndroidIcon

Represents a file path to a bitmap that should be used for as an icon on Android.

Bone

A widget that represents a bone of the loading skeleton effect

BoneMock

A class that provides mock data for generating fake

BoneRenderObject

The render object of the BoneRenderObjectWidget

BoneRenderObjectWidget

A widget that paints a BoxDecoration into a canvas with ManualSkeletonizerPaintingContext.

BootConfig

Configuration for bootstrapping a Nylo application.

Border

A border of a box, comprised of four sides: top, right, bottom, left.

BorderDirectional

A border of a box, comprised of four sides, the lateral sides of which flip over based on the reading direction.

BorderRadius

An immutable set of radii for each corner of a rectangle.

BorderRadiusDirectional

An immutable set of radii for each corner of a rectangle, but with the corners specified in a manner dependent on the writing direction.

BorderRadiusGeometry

Base class for BorderRadius that allows for text-direction aware resolution.

BorderSide

A side of a border of a box.

BottomModalSheetStyle

BottomModalSheetStyle

BottomNavStyle

Style configuration for bottom navigation bar

BottomTabBarColors

Color configuration for the bottom tab bar.

BoxBorder

Base class for box borders that can paint as rectangles, circles, or rounded rectangles.

BoxDecoration

An immutable description of how to paint a box.

BoxPainter

A stateful class that can paint a particular Decoration.

BoxShadow

A shadow cast by a box.

ButtonAnimationStyle

ButtonAnimationStyle defines composable animation styles for buttons. Use factory constructors to create different animation effects.

ButtonSplashStyle

ButtonSplashStyle defines customizable splash effects for buttons. Use factory constructors to create different splash styles.

ButtonState

ButtonState is a stateful widget that manages the state of a button.

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.

CancelToken

Controls cancellation of Dio's requests.

Canvas

An interface for recording graphical operations.

CircleBorder

A border that fits a circle within the available space.

CircularNotchedRectangle

A rectangle with a smooth circular notch.

ClipContext

Clip utilities used by PaintingContext.

CollectionItem<T>

Wrapper class containing item data and position helpers.

CollectionView<T>

The CollectionView widget is a wrapper for the ListView widget. It provides a simple way to display a list of items with full type safety.

CollectionViewStateActions

State actions for CollectionView.

Color

An immutable color value in ARGB format.

ColorFilter

A description of a color filter to apply when drawing a shape or compositing a layer with a particular Paint. A color filter is a function that takes two colors, and outputs one color. When applied during compositing, it is independently applied to each pixel of the layer being drawn before the entire layer is merged with the destination.

ColorProperty

DiagnosticsProperty that has an Color as value.

ColorSwatch<T>

A color that has a small table of related colors called a "swatch".

ConditionalGuard

Conditionally apply a guard based on a predicate.

Connective

A widget that rebuilds based on connectivity state.

ContentUriAndroidIcon

Represents a content URI that should be used for as an icon on Android.

ContinuousRectangleBorder

A rectangular border with smooth continuous transitions between the straight sides and the rounded corners.

CupertinoDatePickerModalSheet

CupertinoDatePickerOptions

Options to customize the CupertinoDatePicker.

CupertinoDatePickerOptionsStyle

CurrencyInputMatcher

Currency input matcher

CurrencyMeta

Currency meta data

DarwinInitializationSettings

Plugin initialization settings for Darwin-based operating systems such as iOS and 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

DateTimeField

DateTimeField

DateTimeFormField

A FormField that contains a DateTimeField.

Decoration

A description of a box decoration (a decoration applied to a Rect).

DecorationImage

An image for a box decoration.

DecorationImagePainter

The painter for a DecorationImage.

DecoratorTextField

DecoratorTextField is a class that helps in managing form text fields

DefaultResponse<T>

Base class used to handle networking responses

DefaultStyleInformation

The default Android notification style.

DefaultToastNotification

DefaultToastNotification a simple toast notification. This is the fallback widget used when no custom toast styles are registered.

DevPanelConfig

Configuration for the dev panel.

DevPanelStore

Central data store for the dev panel.

Dio

Dio enables you to make HTTP requests easily.

DioApiService

Base API Service class

DioMixin

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.

EdgeInsets

An immutable set of offsets in each of the four cardinal directions.

EdgeInsetsDirectional

An immutable set of offsets in each of the four cardinal directions, but whose horizontal components are dependent on the writing direction.

EdgeInsetsGeometry

Base class for EdgeInsets that allows for text-direction aware resolution.

ErrorInterceptorHandler

The handler for interceptors to handle error occurred during the request.

ErrorStack

The main entry point for ErrorStack.

ErrorStackConfig

Configuration options for ErrorStack.

ErrorStackDevPanel

ErrorStackDevPanel

ErrorStackDevPanelSheet

The main dev panel bottom sheet with tabs.

ErrorStackHandler

Handles Flutter errors by logging, parsing stack traces, and building appropriate error widgets.

ErrorStackNavigatorObserver

A NavigatorObserver that automatically tracks route changes.

ErrorStackReleaseWidget

Widget to display a release error stack. This widget is displayed when the app is in release mode. It displays a simple error message.

ErrorStackStorage

Default storage implementation using FlutterSecureStorage.

ErrorStackStorageBase

Abstract interface for ErrorStack storage operations.

ExactAssetImage

Fetches an image from an AssetBundle, associating it with the given scale.

FactoryDefinition<T>

Factory definition container.

FactoryDefinitionWithOverrides<T>

Factory definition with overrides support.

FactoryState<T>

Factory state modifier container.

FadeOverlay

A widget that applies a gradient fade effect over its child.

Field

Represents a form field with configuration, validation, and state management capabilities.

FieldBaseState<T extends StatefulWidget>

Abstract base class for form field widget states.

FieldDefinition

Defines a field's initial value and optional options for use in NyFormWidget.init.

FieldStyle

Base class for defining styling options for form fields.

FieldStyleCheckbox

Style configuration for checkbox fields.

FieldStyleChip

Style configuration for chip-based selection fields.

FieldStyleDateTimePicker

Style configuration for date and time picker fields.

FieldStylePicker

FieldStylePicker is used to define the style for a picker field.

FieldStyleRadio

Style configuration for radio button fields.

FieldStyleRangeSlider

Style configuration for range slider fields.

FieldStyleSlider

Style configuration for slider fields.

FieldStyleSwitchBox

FieldStyleSwitchBox is used to define the style for a switch box field.

FieldStyleTextField

Comprehensive style configuration for text input fields.

FileImage

Decodes the given File object as an image, associating it with the given scale.

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:

FilterArgs

Filter arguments for NetworkLogger.filter

FittedSizes

The pair of sizes returned by applyBoxFit.

FlutterBitmapAssetAndroidIcon

Represents a bitmap asset belonging to the Flutter application that should be used for as an icon on Android.

FlutterLocalNotificationsPlatform

The interface that all implementations of flutter_local_notifications must implement.

FlutterLocalNotificationsPlugin

Provides cross-platform functionality for displaying local notifications.

FlutterLocalNotificationsWindows

The Windows implementation of package:flutter_local_notifications.

FlutterLogoDecoration

An immutable description of how to paint Flutter's logo.

FontFeature

A feature tag and value that affect the selection of glyphs in a font.

FontVariation

An axis tag and value that can be used to customize variable fonts.

FontWeight

The thickness of the glyphs used to draw the text.

FormBuilderStateActions

Provides state management actions for NyFormBuilder widgets.

FormCheckboxStateActions

Provides state management actions for NyFormCheckbox widgets.

FormChipStateActions

Provides state management actions for NyFormChip widgets.

FormCollection

A collection of form options that can be used with various form field widgets.

FormData

A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.

FormDateTimePickerStateActions

State actions for the NyFormDateTimePicker widget

FormOption

Represents a single option item for form components like dropdowns, radios, and chips.

FormPickerStateActions

Provides state management actions for NyFormPicker widgets.

FormRadioStateActions

Provides state management actions for NyFormRadio widgets.

FormRangeSliderStateActions

Provides state management actions for NyFormRangeSlider widgets.

FormRule

Base class for all form validation rules.

FormRuleBeginsWith

FormRuleBooleanFalse

FormRuleBooleanTrue

FormRuleCapitalized

FormRuleContains

FormRuleCustom

FormRuleDate

FormRuleDateAgeIsOlder

FormRuleDateAgeIsYounger

FormRuleDateInFuture

FormRuleDateInPast

FormRuleEmail

FormRuleEndsWith

FormRuleEquals

FormRuleEquals This rule checks if the input data is equal to a specified data source.

FormRuleLowercase

FormRuleMaxLength

FormRuleMaxSize

FormRuleMaxValue

FormRuleMinLength

FormRuleMinSize

FormRuleMinValue

FormRuleNotEmpty

FormRuleNumeric

FormRulePassword

FormRulePhoneNumberUk

FormRulePhoneNumberUs

FormRulePostcodeUk

FormRuleRegex

FormRuleUppercase

FormRuleUrl

FormRuleZipcodeUs

FormSliderStateActions

Provides state management actions for NyFormSlider widgets.

FormStateActions

The base class for form state actions This class is used to manage the state of the form fields

FormSwitchBoxStateActions

Provides state management actions for NyFormSwitchBox widgets.

FormTextFieldStateActions

Provides state management actions for NyFormTextField widgets.

FormValidationError

Represents a validation failure response.

FormValidationResponse

Represents the response of a form validation process. This class is used to encapsulate the result of a validation check, indicating whether the form is valid or not, along with an optional message.

FormValidationResult

FormValidationSuccess

Represents a successful validation response

FormValidator

FractionalOffset

An offset that's expressed as a fraction of a Size.

FusedTransformer

A Transformer that has a fast path for decoding UTF8-encoded JSON. If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions, this transformer is significantly faster than the default SyncTransformer and the BackgroundTransformer. This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response, which is faster than decoding the utf8-encoded JSON in two separate steps, since Dart uses a special fast decoder for this case. See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40

FutureWidget<T>

Simple way to render Future's in your project.

GeneralColors

General color configuration for the app.

GlyphInfo

The measurements of a character (or a sequence of visually connected characters) within a paragraph.

Gradient

A 2D gradient.

GradientRotation

A GradientTransform that rotates the gradient around the center-point of its bounding box.

GradientTransform

Base class for transforming gradient shaders without applying the same transform to the entire canvas.

GuardStack

Compose multiple guards into a single guard.

Headers

The headers class for requests and responses.

HSLColor

A color represented using alpha, hue, saturation, and lightness.

HSVColor

A color represented using alpha, hue, saturation, and value.

HttpClientAdapter

HttpAdapter is a bridge between Dio and HttpClient.

ImageCache

Class for caching images.

ImageCacheStatus

Information about how the ImageCache is tracking an image.

ImageChunkEvent

An immutable notification of image bytes that have been incrementally loaded.

ImageConfiguration

Configuration information passed to the ImageProvider.resolve method to select a specific image.

ImageInfo

A dart:ui.Image object with its corresponding scale.

ImageProvider<T extends Object>

Identifies an image without committing to the precise final asset. This allows a set of images to be identified and for the precise image to later be resolved based on the environment, e.g. the device pixel ratio.

ImageShader

A shader (as used by Paint.shader) that tiles an image.

ImageSizeInfo

Tracks the bytes used by a dart:ui.Image compared to the bytes needed to paint that image without scaling it.

ImageStream

A handle to an image resource.

ImageStreamCompleter

Base class for those that manage the loading of dart:ui.Image objects for ImageStreams.

ImageStreamCompleterHandle

An opaque handle that keeps an ImageStreamCompleter alive even if it has lost its last listener.

ImageStreamListener

Interface for receiving notifications about the loading of an image.

InboxStyleInformation

Used to pass the content for an Android notification displayed using the inbox style.

InitializationSettings

Settings for initializing the plugin for each platform.

InlineSpan

An immutable span of inline content which forms part of a paragraph.

InlineSpanSemanticsInformation

The textual and semantic label information for an InlineSpan.

InputField

Nylo's Text Field Widget

Interceptor

Interceptor helps to deal with RequestOptions, Response, and DioException during the lifecycle of a request before it reaches users.

Interceptors

A Queue-Model list for Interceptors.

InterceptorsWrapper

A helper class to create interceptors in ease.

IOSFlutterLocalNotificationsPlugin

iOS implementation of the local notifications plugin.

IOSInitializationSettings

Plugin initialization settings for iOS

IOSNotificationConfig

Configuration options specific to iOS notifications.

JourneyButtonStyle

Base class for defining the style and parameters of journey buttons. JourneyButtonStyles:

JourneyCircularProgress

A circular progress indicator for journeys

JourneyContent

A reusable content widget for journey pages

JourneyDotProgress

A dot-based progress indicator for journeys

JourneyNumberedProgress

A numbered step progress indicator for journeys

JourneyProgressIndicator

Base class for defining the style and parameters of a journey progress indicator. JourneyProgressIndicators:

JourneyProgressStyle

Comprehensive configuration for journey progress display.

JourneySegmentProgress

A segmented progress bar for journeys

JourneyState<T extends StatefulWidget>

A specialized state class for journey pages in NavigationHub journey layouts

JourneyTimelineProgress

A timeline-style progress indicator for journeys

JsonHelper

Json helper class

LanguageSwitcher

LanguageSwitcher is a widget that allows you to switch languages in your app. You can use it in the AppBar or as a bottom sheet modal using the showBottomModal method. Example:

LanguageSwitcherAnimationStyle

Configures animations for LanguageSwitcher inline popup trigger and bottom modal list items.

LanguageSwitcherStateActions

State actions for LanguageSwitcher.

LinearBorder

An OutlinedBorder like BoxBorder that allows one to define a rectangular (box) border in terms of zero to four LinearBorderEdges, each of which is rendered as a single line.

LinearBorderEdge

Defines the relative size and alignment of one LinearBorder edge.

LinearGradient

A 2D linear gradient.

LineMetrics

LineMetrics stores the measurements and statistics of a single line in the paragraph.

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.

ListParam<T>

Indicates a param being used as queries or form data, and how does it gets formatted.

LoadingStyle

The LoadingStyle class is used to determine the type of loading widget

Locale

An identifier used to select a user's language and formatting preferences.

LocalNotification

A class for creating and sending local notifications on iOS and Android.

LogEntry

Represents a console log entry.

LogInterceptor

LogInterceptor is used to print logs during network requests. It should be the last interceptor added, otherwise modifications by following interceptors will not be logged. This is because the execution of interceptors is in the order of addition.

MacOSFlutterLocalNotificationsPlugin

macOS implementation of the local notifications plugin.

MaskFilter

A mask filter to apply to shapes as they are painted. A mask filter is a function that takes a bitmap of color pixels, and returns another bitmap of color pixels.

MaterialDatePickerOptions

Options to configure the DatePickerDialog.

MaterialTimePickerOptions

Options to configure the TimePickerDialog.

MatrixUtils

Utility functions for working with matrices.

MediaStyleInformation

Used to pass the content for an Android notification displayed using the media style.

MemoryImage

Decodes the given Uint8List buffer as an image, associating it with the given scale.

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.

MockApiRequest

Represents a mock API request.

MockResponse

Represents a mock API response.

Model<T>

Nylo's Model class

MsixUtils

Helpful methods to support MSIX and package identity.

MultiFrameImageStreamCompleter

Manages the decoding and scheduling of image frames.

MultipartFile

An upload content that is a part of MultipartRequest. This doesn't need to correspond to a physical file.

NavBarData

Data passed to custom nav bar builders

NavigationHub<T extends StatefulWidget>

NavigationHubLayout

NavigationHubStateActions

Navigation hub state actions

NavigationTab

NavigationTab is a class that holds the title, page, icon, activeIcon, backgroundColor, tooltip, and meta data of a bottom navigation tab.

NetworkImage

Fetches the given URL from the network, associating it with the given scale.

NetworkLogger

A network logger interceptor for Dio Provides pretty-printed request/response logging with:

NotchedShape

A shape with a notch in its outline.

NotificationAppLaunchDetails

Contains details on the notification that launched the application.

NotificationAttachment

Represents an attachment for a notification.

NotificationDetails

Contains notification details specific to each platform.

NotificationResponse

Details of a Notification Action that was triggered.

NotificationsEnabledOptions

Data class that represent current state of notification options.

NyAction

Nylo's NyAction class

NyApiService

NyApp

A unified widget that combines theme management and localization.

NyAppUsage

Nylo's NyAppUsage class This class is used to monitor app usage.

NyArgument

Nylo Route Argument Contains the data passed from another route.

NyBaseModal

NyBaseModal

NyBaseState<T extends StatefulWidget>

NyCache

Cache helper

NyColor

Helper to find correct color from the context.

NyColorStyleBuilder<T>

A widget that rebuilds with typed color styles when the theme changes.

NyConnectivity

Connectivity helper for checking network status.

NyController

Base NyController

NyEnv

Base class for environment configuration.

NyEnvRegistry

Registry for the user's generated Env class.

NyEvent

Base interface for Events

NyEventBus

NyEventCallbackListener

NyEventSubscription<T extends NyEvent>

Subscription handle that can be used to cancel listening

NyFactory

Laravel-style model factories for testing.

NyFaker

Faker class for generating random test data.

NyFieldStatefulWidget

A stateful widget base class for creating form field widgets.

NyFormActions

Helper class for dispatching form actions by name.

NyFormBuilder

A builder widget for forms that lets developers create custom fields inline.

NyFormCheckbox

A checkbox widget for forms that allows users to toggle a boolean value.

NyFormChip

A customizable chip selection widget for forms that allows users to select multiple options.

NyFormData

Base class for defining form structure, data, and behavior in Nylo applications.

NyFormDateTimePicker

A NyFormDateTimePicker widget for Form Fields

NyFormPicker

A dropdown/picker selection widget for forms that allows users to choose from a list of options.

NyFormRadio

A radio button group widget for forms that allows users to select a single option.

NyFormRangeSlider

A range slider widget for forms that allows users to select a range of values.

NyFormSlider

A slider widget for forms that allows users to select a value from a range.

NyFormSwitchBox

A switch toggle widget for forms that allows users to toggle a boolean value.

NyFormTextField

A text input field widget designed for use within forms.

NyFormWidget

NyFormWidget is an abstract StatefulWidget for building forms declaratively.

NyListener

Base class for listeners

Nylo

NyLocaleHelper

Helper class for locale-related operations.

NyLocalization

NyLocalization Singleton object that handles localization in Nylo

NyLocalizationConfig

Configuration class for NyLocalization.

NyLogEntry

Represents a single log entry with metadata.

NyLogger

Logger used for messages you want to print to the console.

NyMockApi

API mocking utilities for testing.

NyMockChannels

Auto-mocking for common Flutter platform channels used in Nylo.

NyMockRouteGuard

A mock route guard for testing NyPage route guard behavior.

NyModalLayout

NyModalLayout

NyNavigator

The NyNavigator class is a singleton class that manages the routing of the application. It is a thin layer on top of Navigator to help you encapsulate and manage routing at one place.

NyPage<T extends StatefulWidget>

NyProvider

Base class for Providers.

NyQueryParameters

Nylo Query Parameters Contains the data passed from the URL. E.g. "/home-page?userId=2 data = {"userId": "2"}

NyRequest

Base class to handle requests

NyResponse<T>

Enhanced API Response class that provides access to the full Dio Response along with morphed data and useful response utilities

NyRouteGuard

Base class for Nylo route guards.

NyRouteHistoryObserver

A NavigatorObserver that keeps track of the current route.

NyRouter

NyRouterRoute manages routing, registering routes with transitions, navigating to routes, closing routes. It is a thin layer on top of Navigator to help you encapsulate and manage routing at one place.

NyRouterOptions

Options to configure a Nylo Router instance.

NyRouterRoute

The NyRouterRoute class is used to define a route in the Nylo Router.

NyScheduler

Nylo's Scheduler class This class is used to schedule tasks to run at a later time.

NySession

NyState<T extends StatefulWidget>

NyStatefulWidget<T extends BaseController>

StatefulWidget's include a BaseController to access from your child state.

NyStateTestHelpers

Helpers for testing EventBus-driven state management in NyPage and NyState.

NyStorage

Base class to help manage local storage

NyTest

Main testing orchestrator for Nylo testing framework.

NyTestCache

In-memory cache implementation for testing.

NyThemeBuilder

A widget that rebuilds when the theme changes.

NyThemeManager

Singleton class to manage app themes.

NyThemeProvider

Widget that provides theme context to its descendants.

NyThemeStorage

Storage service for theme persistence.

NyTime

NyTime - Time manipulation utilities for testing.

NyToastRecorder

A simple recorder that tracks toast notifications shown during tests.

NyWidgetTest

Widget testing utilities for Nylo applications.

OfflineBanner

Widget that shows an offline banner at the top of the screen.

Offset

An immutable 2D floating-point offset.

OneFrameImageStreamCompleter

Manages the loading of dart:ui.Image objects for static ImageStreams (those with only one frame).

Options

The configuration for a single request. BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.

OutlinedBorder

A ShapeBorder that draws an outline with the width and color specified by side.

OvalBorder

A border that fits an elliptical shape.

PageNotFound

PageRequest

Legacy page request class for backward compatibility.

PageTransition<T>

A flexible page transition class that extends PageRouteBuilder to provide a variety of customizable transition animations between screens.

PageTransitionSettings

This class contains all page transition settings.

Paint

A description of the style to use when drawing on a Canvas.

PaintingEffect

An abstraction for skeleton painting effects consumed by the Skeletonizer.animationController

ParameterizedGuard<P>

A route guard that accepts configuration parameters.

Path

A complex, one-dimensional subset of a plane.

PendingNotificationRequest

Details of a pending notification that has not been delivered.

Person

Details of a person e.g. someone who sent a message.

PickerListTileStyle

Style configuration for individual list tiles in a picker bottom sheet.

PlaceholderDimensions

Holds the Size and baseline required to represent the dimensions of a placeholder in text.

PlaceholderSpan

An immutable placeholder that is embedded inline within text.

Pullable

The Pullable widget helps you refresh and load more content with a flexible API.

PullableConfig

Configuration for the Pullable widget

PulseEffect

Creates a painting effect where a two colors are lerped back nad forward based on animation value

QueuedInterceptor

Interceptor in queue.

QueuedInterceptorsWrapper

A helper class to create QueuedInterceptor in ease.

RadialGradient

A 2D radial gradient.

Radius

A radius for either circular or elliptical shapes.

RawResourceAndroidNotificationSound

Represents a raw resource belonging to the Android application that should be used for the notification sound.

RawShimmerEffect

A customizable shimmer effect where you can provide your own colors, stops, and other gradient properties

Rect

An immutable, 2D, axis-aligned, floating-point rectangle whose coordinates are relative to a given origin.

RedirectConfig

Configuration for a redirect action.

RedirectRecord

A record that records the redirection happens during requests, including status code, request method, and the location.

RenderIgnoredSkeleton

A Render object that paints nothing when skeletonizer is enabled

RequestInterceptorHandler

The handler for interceptors to handle before the request has been sent.

RequestOptions

The internal request option class that is the eventual result after BaseOptions and Options are composed.

ResizeImage

Instructs Flutter to decode the image at the specified dimensions instead of at its native size.

ResizeImageKey

Key used internally by ResizeImage.

Response<T>

The Response class contains the payload (could be transformed) that respond from the request, and other information of the response.

ResponseBody

The response wrapper class for adapters.

ResponseInterceptorHandler

The handler for interceptors to handle after respond.

RoundedRectangleBorder

A rectangular border with rounded corners.

RoundedSuperellipseBorder

A rectangular border with rounded corners following the shape of an RSuperellipse.

RouteContext<T>

Immutable context passed to route guards.

RouteData

Route data class for navigation configuration.

RouteEntry

Represents a navigation route entry in the route history.

RouteGuard

@deprecated Use NyRouteGuard instead. Legacy class interface for backward compatibility.

RouteMatch

Represents a matched route with its parameters.

RouteMatcher

The RouteMatcher class is used to match the route with the registered routes.

RRect

An immutable rounded rectangle with the custom radii for all four corners.

RSTransform

A transform consisting of a translation, a rotation, and a uniform scale.

RSuperellipse

An immutable rounded superellipse.

Shader

Base class for objects such as Gradient and ImageShader which correspond to shaders as used by Paint.shader.

ShaderWarmUp

Interface for drawing an image to warm up Skia shader compilations.

Shadow

A single shadow.

ShapeBorder

Base class for shape outlines.

ShapeDecoration

An immutable description of how to paint an arbitrary shape.

ShimmerEffect

Builds a painting effect where a linear gradient is used to create a shimmer-like effect

Size

Holds a 2D floating-point size.

Skeleton

An interface for a skeleton annotation widget skeleton annotation widgets are used to configure or customize how the skeleton effect is applied to the child widget

Skeletonizer

Paints a skeleton of the child widget

SkeletonizerConfig

Provided the scoped SkeletonizerConfigData to descended widgets

SkeletonizerConfigData

The immutable configuration data for the skeletonizer theme.

SkeletonizerScope

Provides the skeletonizer activation information to the descent widgets

SkeletonizerState

The state of Skeletonizer widget

SliverSkeletonizer

A Skeletonizer widget that can be used in a CustomScrollView

SolidColorEffect

Creates a none-animated painting effect

Spacing

A utility widget that creates consistent spacing between UI elements.

StadiumBorder

A border that fits a stadium-shaped border (a box with semicircles on the ends) within the rectangle of the widget it is applied to.

StarBorder

A border that fits a star or polygon-shaped border within the rectangle of the widget it is applied to.

StateAction

StateAction class

StateActions

State actions

StorageConfig

Storage configuration for Nylo. You can set the storage options for each platform. E.g. AndroidOptions, IOSOptions, LinuxOptions, WindowsOptions, WebOptions, MacOsOptions

StorageEntry

Represents a reference to a stored value.

StorageManager

Storage manager for Nylo.

StrutStyle

Defines the strut, which sets the minimum height a line can be relative to the baseline.

StyledText

StyledText allows you to display rich text with different styles.

StyleInformation

Abstract class for defining an Android notification style

SweepGradient

A 2D sweep gradient.

SwitchAnimationConfig

Holds the configuration for the switch animation

SyncTransformer

If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the transformer by setting the Dio.transformer.

TextAlignVertical

The vertical alignment of text within an input box.

TextBoneBorderRadius

Holds border radius information for TextElement

TextBox

A rectangle enclosing a run of text.

TextDecoration

A linear decoration to draw near the text.

TextFieldStateActions

State actions for InputField.

TextHeightBehavior

Defines how to apply TextStyle.height over and under text.

TextPainter

An object that paints a TextSpan tree into a Canvas.

TextPosition

A position in a string of text.

TextRange

A range of characters in a string of text.

TextScaler

A class that describes how textual contents should be scaled for better readability.

TextSelection

A range of text that represents a selection.

TextSpan

An immutable span of text.

TextStyle

An immutable style describing how to format and paint text.

TextTr

A Text widget that automatically translates its content using Nylo's localization system.

ThemeColor

Base color configuration for app themes.

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.

ToastAnimation

ToastAnimation defines animation styles for toast notifications. Use factory constructors to create different animation effects.

ToastMeta

Toast Meta makes it easy to use pre-defined styles in the toast alert.

ToastNotificationRegistry

Registry for toast notification styles. Stores widget factories keyed by string IDs (e.g., "success", "warning"). Use ToastNotificationRegistry.register to add custom toast styles.

ToastRecord

A recorded toast notification entry.

Transformer

Transformer allows changes to the request/response data before it is sent/received to/from the server.

TransformProperty

Property which handles Matrix4 that represent transforms.

TransitionType

A utility class that simplifies the creation of page transitions by encapsulating transition types and their associated settings.

UIDebugOverlay

A widget that applies UI debug overlays based on DevPanelStore settings.

UpdateState

UpdateState Model.

UriAndroidNotificationSound

Represents a URI on the Android device that should be used for the notification sound.

WindowsAction

A button in a Windows notification.

WindowsColumn

A vertical column of text and images in a Windows notification.

WindowsHeader

A header that groups multiple Windows notifications.

WindowsImage

An image in a Windows notification.

WindowsInitializationSettings

Plugin initialization settings for Windows.

WindowsInput

A text or multiple choice input element in a Windows notification.

WindowsNotificationAudio

Specifies custom audio to play during a notification.

WindowsNotificationDetails

Contains notification details specific to Windows.

WindowsNotificationPart

A text or image element in a Windows notification.

WindowsNotificationText

Text in a Windows notification.

WindowsProgressBar

A progress bar in a Windows notification.

WindowsRow

A group of notification content that must be displayed as a whole row.

WindowsSelection

An option that can be selected by a WindowsSelectionInput.

WindowsSelectionInput

A multiple choice input.

WindowsTextInput

A text input.

WordBoundary

A TextBoundary subclass for locating word breaks.

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.

AudioAttributesUsage

The available audio attributes usages for an Android service.

Axis

The two cardinal directions in two dimensions.

AxisDirection

A direction along either the horizontal or vertical Axis in which the origin, or zero position, is determined.

BlendMode

Algorithms to use when painting on the canvas.

BlurStyle

Styles to use for blurs in MaskFilter objects.

BoneButtonType

The type of button bone

BorderStyle

The style of line to draw for a BorderSide in a Border.

BoxFit

How a box should be inscribed into another box.

BoxShape

The shape to use when rendering a Border or BoxDecoration.

ButtonAnimationType

The type of button animation

ButtonSplashType

The type of splash effect for buttons

CachePolicy

Cache policy for API requests.

Clip

Different ways to clip content.

CollectionViewKind

The kind of collection view to build.

ColorBlindnessMode

Color blindness simulation modes.

DarwinNotificationActionOption

Describes when & how the notification action is displayed.

DarwinNotificationCategoryOption

Desribes the options of each notification category.

DateTimeComponents

The components of a date and time representations.

DateTimeFieldPickerMode

The mode of the DateTimeField.

DateTimeFieldPickerPlatform

The platform to use for the pickers.

Day

The days of the week.

DevPanelLogLevel

Log severity levels for the dev panel console logging.

DioExceptionType

The exception enumeration indicates what type of exception has happened during requests.

ErrorStackLogLevel

The level of logging to be displayed when an error occurs.

FileAccessMode

The file access mode when downloading a file, corresponds to a subset of dart:io::FileMode.

FilterQuality

Quality levels for image sampling in ImageFilter and Shader objects that sample images and for Canvas operations that render images.

FlutterLogoStyle

Possible ways to draw Flutter's logo.

FontStyle

Whether to use the italic type variation of glyphs in the font.

GroupAlertBehavior

The available alert behaviours for grouped notifications.

GuardResult

The result of a route guard check.

ImageRepeat

How to paint any portions of a box not covered by an image.

Importance

The available importance levels for Android notifications.

InterruptionLevel

Type used to indicate the importance and delivery timing of a notification.

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.

ListFormat

Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.

LoadingStyleType

The LoadingStyleType enum is used to determine the type of loading widget

LocaleType

Defines how the locale should be determined

LogLevelType

Log level for NetworkLogger

NavigationType

The NavigationType enum is used to define the type of navigation to be

NotificationResponseType

The possible notification response types

NotificationUpdateResult

The result of updating a notification.

NotificationVisibility

Defines the notification visibility on the lockscreen.

NyConnectivityState

Connectivity state enum for NyConnective widget.

NyThemeType

Enum representing the type of theme.

PageTransitionType

Transition enum

PaintingStyle

Strategies for painting shapes and paths on a canvas.

PathFillType

Determines the winding rule that decides how the interior of a Path is calculated.

PathOperation

Strategies for combining paths.

PickerListTileIndicator

Indicator type for picker list tiles.

PlaceholderAlignment

Where to vertically align the placeholder relative to the surrounding text.

Priority

Priority for notifications on Android 7.1 and lower.

ProgressIndicatorPosition

The position of the progress indicator in the journey layout

PullableHeaderType

Header types for the Pullable widget

RenderComparison

The description of the difference between two objects, in the context of how it will affect the rendering.

RepeatInterval

The available intervals for periodically showing notifications.

ResizeImagePolicy

Configures the behavior for ResizeImage.

ResponseType

Indicates which transformation should be applied to the response data.

RouteAction

The type of navigation action that occurred.

SemanticAction

The available meanings that can be associated with a notification action.

SkeletonizerEffect

The effect to use for the skeletonizer loading style

StorageSource

The source of stored data.

StrokeCap

Styles to use for line endings.

StrokeJoin

Styles to use for line segment joins.

TextAffinity

A way to disambiguate a TextPosition when its offset could match two different locations in the rendered string.

TextAlign

Whether and how to align text horizontally.

TextBaseline

A horizontal line used for aligning text.

TextBoneBorderShape

Enum to define the type of border for text bones

TextDecorationStyle

The style in which to draw a text decoration

TextDirection

A direction in which text flows.

TextLeadingDistribution

How the "leading" is distributed over and under the text.

TextOverflow

How overflowing text should be handled.

TextWidthBasis

The different ways of measuring the width of one or more lines of text.

TileMode

Defines how to handle areas outside the defined bounds of a gradient or image filter.

ToastAnimationType

Animation type for toast notifications.

ToastNotificationPosition

Position where the toast notification appears.

UrlLaunchModeType

Launch mode for opening URLs.

VertexMode

Defines how a list of points is interpreted when drawing a set of triangles.

VerticalDirection

A direction in which boxes flow vertically.

WebHtmlElementStrategy

The strategy for Image.network and NetworkImage to decide whether to display images in HTML elements contained in a platform view instead of fetching bytes.

WindowsActionPlacement

Decides how a WindowsAction is placed on a notification.

WindowsActivationType

Decides how the WindowsAction will launch the app.

WindowsButtonStyle

Decides how a WindowsAction will be styled.

WindowsHeaderActivation

Decides how the application will open when the header is pressed.

WindowsImageCrop

How a Windows notification image can be cropped.

WindowsImagePlacement

Where a Windows notification image can be placed.

WindowsInputType

The type of a WindowsInput.

WindowsNotificationBehavior

Decides how a WindowsAction will react to being pressed.

WindowsNotificationDuration

The duration for a Windows notification.

WindowsNotificationScenario

The scenario a notification is being used for.

WindowsNotificationSound

A preset sound for a Windows notification.

WindowsTextPlacement

Where text can be placed in a Windows notification.

Mixins

BottomNavPageControls

Mixin for the page controls

FormSubmittable

Mixin for button widgets that can be wired to form submission.

HasApiService<T extends NyApiService>

HasApiService mixin for classes that need access to an API service.

NyPageTestMixin

Mixin for testing NyState and NyPage widgets.

OptionsMixin

The mixin class for options that provides common attributes.

PaintingBinding

Binding for the painting library.

Extensions

CachePolicyExtension on CachePolicy

Extension methods for CachePolicy.

ColorOpacityExt on Color

ConnectiveExtension on Widget

Extension to add connectivity-aware functionality to widgets.

ConnectivityResultExtension on ConnectivityResult

Extension to convert ConnectivityResult to NyConnectivityState.

DarkModeExt on BuildContext

Check if the device is in Dark Mode

FormValidatorExtensionExt on List<FormValidator>

ListFormValidationResponseExtensionExt on FormValidationResponseBag

ListUpdateExtensionExt on List<T>

Extensions for List

NyAppContext on BuildContext

Extension on BuildContext for easier theme and app access.

NyAssetImageExt on AssetImage

Extensions for AssetImage

NyBoolExt on bool?

Extensions for bool

NyBoxScrollViewExt on BoxScrollView

Extensions for ListView

NyColumnExt on Column

Extensions for Column

NyContextExt on BuildContext

NyDateTimeExt on DateTime?

Extensions for DateTime

NyDoubleExt on double?

Extensions for double

NyEventExtension on NyEvent

Extensions on NyEvent

NyImageExt on Image

Extensions for Image

NyIntExt on int?

Extensions for int

NyListExt on List?

Extensions for List

NyListGenericExt on List<T>

Extensions for List

NyListWidgetExt on List<Widget>

Extensions for List<Widget>

NyMapEntryExt on Iterable<MapEntry<String, dynamic>>

NyMapExt on Map?

Extensions for Map

NyRequestHeaders on RequestHeaders

NyResponseExt on Response

Extensions for Response

NyRowExt on Row

Extensions for Row

NySingleChildRenderObjectWidgetExt on SingleChildRenderObjectWidget

Extensions for SingleChildRenderObjectWidget

NyStatefulExt on StatefulWidget

NyStatelessWidgetExt on StatelessWidget

Extensions for StatelessWidget

NyStorageKeyExt on StorageKey

NyStrExt on String?

Extensions for String

NyStringExt on String

Extensions for String

NyTextExt on Text

Extensions for Text

NyWidgetExt on Widget

Extensions for Widget

NyWidgetTesterExtension on WidgetTester

Extension on WidgetTester for Nylo-specific widget testing.

PaginateExt on List<T>

Extension on the List<T> class that adds a paginate method for easy pagination of list elements.

PullableControllerExtension on RefreshController

Extension to provide convenient methods for RefreshController

RouteViewExt on RouteView

StringExtensionExt on String

Extensions for String

Translation on String

Translate String.

Constants

kDefaultCancelStyle → const TextStyle

kDefaultFontSize → const double

The default font size if none is specified.

kTextHeightNone → const double

A TextStyle.height value that indicates the text span should take the height defined by the font, which may not be exactly the height of TextStyle.fontSize.

nyloVersion → const String

Nylo version

skeletonizerConfigData → const SkeletonizerConfigData

Singleton instance for skeletonizer theme configurations.

Properties

debugCaptureShaderWarmUpImage ↔ ShaderWarmUpImageCallback

Called by ShaderWarmUp.execute immediately after it creates an Image.

getter/setter pair

debugCaptureShaderWarmUpPicture ↔ ShaderWarmUpPictureCallback

Called by ShaderWarmUp.execute immediately after it creates a Picture.

getter/setter pair

debugDisableShadows ↔ bool

Whether to replace all shadows with solid color blocks.

getter/setter pair

debugImageOverheadAllowance ↔ int

The number of bytes an image must use before it triggers inversion when debugInvertOversizedImages is true.

getter/setter pair

debugInvertOversizedImages ↔ bool

If true, the framework will color invert and horizontally flip images that have been decoded to a size taking at least debugImageOverheadAllowance bytes more than necessary.

getter/setter pair

debugNetworkImageHttpClientProvider ↔ HttpClientProvider?

Provider from which NetworkImage will get its HttpClient in debug builds.

getter/setter pair

debugOnPaintImage ↔ PaintImageCallback?

If not null, called when the framework is about to paint an Image to a Canvas with an ImageSizeInfo that contains the decoded size of the image as well as its output size.

getter/setter pair

imageCache → ImageCache

The singleton that implements the Flutter framework's image cache.

no setter

Functions

api<T extends NyApiService>(dynamic request(T request), {Map<String, dynamic> headers = const {}, String? bearerToken, String? baseUrl, int? page, String? paramPage, String? paramPerPage, int? perPage, int retry = 0, Duration? retryDelay, bool retryIf(DioException dioException)?, bool? shouldSetAuthHeaders, dynamic onSuccess(Response response, dynamic data)?, dynamic onError(DioException dioException)?, Duration? cacheDuration, String? cacheKey, List<Type> events = const []}) → Future

api helper Example:

apiWasCalled(String endpoint, {String? method, int? times}) → Matcher

Custom matcher for API calls.

applyBoxFit(BoxFit fit, Size inputSize, Size outputSize) → FittedSizes

Apply a BoxFit value.

authAuthenticate({dynamic data, String? session}) → Future<void>

Authenticate a session.

authData({String? field, String? session}) → dynamic

Get auth data for a session.

authDeviceId() → Future<String>

Get the device ID.

authIsAuthenticated({String? session}) → Future<bool>

Check if a session is authenticated.

authKey([String? session]) → String

Get the storage key for a session.

authLogout({String? session}) → Future<void>

Logout from a session.

authLogoutAll({List<String> sessions = const []}) → Future<void>

Logout from all sessions.

authSet(dynamic update(dynamic data), {String? session}) → Future<void>

Update auth data for a session.

authSyncToBackpack({String? session}) → Future<void>

Sync auth data to backpack for a session.

axisDirectionIsReversed(AxisDirection axisDirection) → bool

Returns whether traveling along the given axis direction visits coordinates along that axis in numerically decreasing order.

axisDirectionToAxis(AxisDirection axisDirection) → Axis

Returns the Axis that contains the given AxisDirection.

backpackDelete(String key) → void

Delete a value using a key.

backpackDeleteAll() → void

Delete all values from Backpack.

backpackHas(String key, {dynamic value}) → Matcher

Custom matcher for Backpack containing key.

backpackNylo({String key = 'nylo'}) → Nylo

Returns an instance of Nylo.

backpackRead<T>(String key, {dynamic defaultValue}) → T?

Read data from the Backpack with a key.

backpackSave(String key, dynamic value) → void

Save a value using a key and value.

bootFinished(Nylo nylo, Map<Type, NyProvider> providers, {String key = "nylo", bool? enableDebugLogging, bool throwOnError = false}) → Future<Nylo>

Called after Nylo finishes setup.

cache() → NyCache

Get the cache instance. Throws StateError if cache is not initialized.

canOpenUrl(String url) → Future<bool>

Check if a URL can be opened.

clearBadgeNumber() → Future<void>

Clear badge number

combineSemanticsInfo(List<InlineSpanSemanticsInformation> infoList) → List<InlineSpanSemanticsInformation>

Combines _semanticsInfo entries where permissible.

dataToModel<T>({required dynamic data, Map<Type, dynamic>? modelDecoders}) → T

Return an object from your modelDecoders using data.

debugAssertAllPaintingVarsUnset(String reason, {bool debugDisableShadowsOverride = false}) → bool

Returns true if none of the painting library debug variables have been changed.

debugCheckCanResolveTextDirection(TextDirection? direction, String target) → bool

Asserts that a given TextDirection is not null.

debugDescribeTransform(Matrix4? transform) → List<String>

Returns a list of strings representing the given transform in a format useful for TransformProperty.

debugFlushLastFrameImageSizeInfo() → void

Flushes inter-frame tracking of image size information from paintImage.

decodeImageFromList(Uint8List bytes) → Future<Image>

Creates an image from a list of bytes.

defaultDioExceptionReadableStringBuilder(DioException e) → String

The default implementation of building a readable string of DioException.

define({dynamic value, dynamic options}) → FieldDefinition

Helper to set both a value and options for a form field in NyFormWidget.init.

detect24HourFormat(BuildContext context) → bool

A function that returns a boolean value to determine if the 24-hour format should be used based on the current locale.

dump(dynamic value, {String? tag, bool alwaysPrint = false}) → void

Dump a message to the console. Example:

event<T>({Map? data, bool? broadcast}) → Future

Event helper for Nylo Example:

expectApiCalled(String endpoint, {String? method, int? times}) → void

Assert that an API endpoint was called.

expectApiCalledWith(String endpoint, {String? method, dynamic data}) → void

Assert that an API endpoint was called with specific request data.

expectApiNotCalled(String endpoint, {String? method}) → void

Assert that an API endpoint was not called.

expectAuthenticated<T>() → void

Assert that a user is authenticated.

expectBackpackContains(String key, {dynamic value}) → void

Assert that Backpack contains a specific key.

expectBackpackNotContains(String key) → void

Assert that Backpack does not contain a specific key.

expectDebugMode() → void

Assert that Nylo is in debug mode.

expectDevelopingMode() → void

Assert that Nylo is in developing mode.

expectEnv(String key, dynamic expectedValue) → void

Assert that an environment variable has a specific value.

expectEnvSet(String key) → void

Assert that an environment variable is set (not null).

expectGuest() → void

Assert that no user is authenticated (guest).

expectLoadingNamed(WidgetTester tester, Finder finder, String name) → void

Assert that a named loading key is active in a NyPage/NyState widget.

expectLocale(String locale) → void

Assert that the current locale matches.

expectLocked(WidgetTester tester, Finder finder, String name) → void

Assert that a named lock is currently held in a NyPage/NyState widget.

expectNotLoadingNamed(WidgetTester tester, Finder finder, String name) → void

Assert that a named loading key is not active in a NyPage/NyState widget.

expectNotLocked(WidgetTester tester, Finder finder, String name) → void

Assert that a named lock is not held in a NyPage/NyState widget.

expectNoToastShown({String? id, String? description}) → void

Assert that no toast notification was shown matching the criteria.

expectNotRoute(String route) → void

Assert that the current route is not the specified route.

expectNotVisible(Finder finder) → void

Assert that no widget matching finder is visible in the widget tree.

expectNyloInitialized() → void

Assert that Nylo is initialized.

expectProductionMode() → void

Assert that Nylo is in production mode.

expectRoute(String route) → void

Test helper utilities for Nylo testing.

expectRouteExists(String route) → void

Assert that a route exists in the router.

expectRouteInHistory(String route) → void

Assert that the route history contains a specific route.

expectRoutesExist(List<String> routes) → void

Assert that routes exist in the router.

expectStateAction(String stateName, String action, {int? times}) → void

Assert that a state action was fired to the given stateName.

expectStateData(WidgetTester tester, Finder finder, dynamic matcher) → void

Assert the stateData of a NyPage or NyState widget.

expectStateUpdated(String stateName, {int? times}) → void

Assert that a state update was fired to the given stateName.

expectTestMode() → void

Assert that Nylo is in test mode.

expectTextNotVisible(String text) → void

Assert that the given text is not visible in the widget tree.

expectTextVisible(String text) → void

Assert that the given text is visible in the widget tree.

expectToastShown({String? id, String? description}) → void

Assert that a toast notification was shown.

expectVisible(Finder finder) → void

Assert that a widget matching finder is visible in the widget tree.

expectWidgetCount(Type type, int count) → void

Assert that a widget of the given type appears exactly count times.

fireStateAction(String stateName, String action, {dynamic data}) → void

Fire a state action to a widget identified by stateName.

fireStateUpdate(String stateName, {dynamic data}) → void

Fire an UpdateState event to a widget identified by stateName.

flipAxis(Axis direction) → Axis

Returns the opposite of the given Axis.

flipAxisDirection(AxisDirection axisDirection) → AxisDirection

Returns the opposite of the given AxisDirection.

getAppTextTheme(TextStyle appThemeFont, TextTheme textTheme) → TextTheme

Returns a text theme for a app font. Returns a TextTheme.

getAsset(String asset) → String

Returns the full path for an asset in /assets directory. Usage e.g. getAsset('videos/welcome.mp4');

getEnv(String key, {dynamic defaultValue}) → dynamic

Returns a value from the generated env.g.dart file. The key must exist as a string value e.g. APP_NAME.

getImageAsset(String imageName, {String? path = '/images'}) → String

Returns the full image path for a image in /assets/images/ directory. Provide the name of the image, using imageName parameter.

hasRouteName(String name) → Matcher

Custom matcher for route name.

isDouble(String? s) → bool

Checks if the value is a double (must contain a decimal point). Returns false for integers - use isInteger to check for integers first.

isInteger(String? s) → bool

Checks if the value is an integer.

isType<T>() → TypeMatcher<T>

Matcher for checking if an object is of a specific type.

lerpFontVariations(List<FontVariation>? a, List<FontVariation>? b, double t) → List<FontVariation>?

Interpolate between two lists of FontVariation objects.

listenOn<E extends NyEvent>(dynamic callback(Map? data)) → NyEventSubscription<NyEvent>

loadJson<T>(String fileName, {bool cache = true}) → Future<T?>

Load a json file from the assets folder.

localNotification(String title, String body) → LocalNotification

Creates a new LocalNotification with the given title and body.

match<T>(dynamic value, Map<dynamic, T> values(), {T? defaultValue}) → T

Match a value from a Map of data. Returns defaultValue if no match is found, or throws if no default provided.

now() → DateTime

Get the DateTime.now() value.

nyApi<T>({required dynamic request(T), Map<Type, dynamic> apiDecoders = const {}, Map<String, dynamic> headers = const {}, String? bearerToken, String? baseUrl, int? page, int? perPage, String paramPage = "page", String? paramPerPage, int retry = 0, Duration? retryDelay, bool retryIf(DioException dioException)?, bool? shouldSetAuthHeaders, dynamic onSuccess(Response response, dynamic data)?, dynamic onError(DioException dioException)?, Duration? cacheDuration, String? cacheKey, List<Type> events = const []}) → Future

API helper

nyCi(String description, Future<void> callback()) → void

Run a test only in CI environment.

nyColorStyle<T>(BuildContext context, {String? themeId}) → T

Helper to get the color styles Find a color style from the Nylo's appThemes.

nyColorStyles<T>() → T

Helper function to get color styles from NyThemeManager.

nyEvent<T>({Map? params, Map<Type, NyEvent> events = const {}, bool? broadcast}) → Future<void>

Event helper

nyFailing(String description, Future<void> callback()) → void

Mark a test as expected to fail.

nyGroup(String description, void callback()) → void

Pest-style group wrapper.

nyHexColor(String hexColor) → Color

Hex Color

nyRoutes(dynamic build(NyRouter router)) → NyRouter

Builds the routes in the router.dart file

nySetUp(void callback()) → void

Execute a callback before each test in the current group.

nySetUpAll(void callback()) → void

Execute a callback once before all tests in the current group.

nySkip(String description, Future<void> callback(), String reason) → void

Skip a test with a reason.

nyTearDown(void callback()) → void

Execute a callback after each test in the current group.

nyTearDownAll(void callback()) → void

Execute a callback once after all tests in the current group.

nyTest(String description, Future<void> callback(), {bool skip = false, dynamic tags, Timeout? timeout}) → void

Pest-style test wrapper for Nylo tests.

nyWidgetTest(String description, Future<void> callback(WidgetTester tester), {bool skip = false, dynamic tags, Timeout? timeout}) → void

Pest-style widget test wrapper with Patrol integration.

objectToJson(dynamic object) → Map<String, dynamic>?

Attempts to call toJson() on an object.

openUrl(String url, {UrlLaunchModeType mode = UrlLaunchModeType.externalApplication, bool webOnly = false, Map<String, String>? headers}) → Future<bool>

Opens a URL in the browser.

paintBorder(Canvas canvas, Rect rect, {BorderSide top = BorderSide.none, BorderSide right = BorderSide.none, BorderSide bottom = BorderSide.none, BorderSide left = BorderSide.none}) → void

Paints a border around the given rectangle on the canvas.

paintImage({required Canvas canvas, required Rect rect, required Image image, String? debugImageLabel, double scale = 1.0, double opacity = 1.0, ColorFilter? colorFilter, BoxFit? fit, Alignment alignment = Alignment.center, Rect? centerSlice, ImageRepeat repeat = ImageRepeat.noRepeat, bool flipHorizontally = false, bool invertColors = false, FilterQuality filterQuality = FilterQuality.medium, bool isAntiAlias = false, BlendMode blendMode = BlendMode.srcOver}) → void

Paints an image into the given rectangle on the canvas.

paintZigZag(Canvas canvas, Paint paint, Offset start, Offset end, int zigs, double width) → void

Draw a line between two points, which cuts diagonally back and forth across the line that connects the two points.

positionDependentBox({required Size size, required Size childSize, required Offset target, required bool preferBelow, double verticalOffset = 0.0, double margin = 10.0}) → Offset

Position a child box within a container box, either above or below a target point.

printAlert(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Alert Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printDebug(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Debug Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printEmergency(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Emergency (highest severity) Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printError(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Error Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printInfo(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Info Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printJson(dynamic message, {bool alwaysPrint = false}) → void

Print a message to the console as JSON.

printSuccess(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Success Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printVerbose(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Verbose Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

printWarning(dynamic message, {Map<String, dynamic>? context, bool alwaysPrint = false}) → void

Print a message to the console. Log level: Warning Use context to interpolate values into the message, e.g. 'User {id}' with {'id': '123'}.

pushNotification(String title, String body) → LocalNotification

Creates a new LocalNotification with the given title and body.

routeIf(bool condition, dynamic routeName, {dynamic data, Map<String, dynamic>? queryParameters, NavigationType navigationType = NavigationType.push, dynamic result, bool removeUntilPredicate(Route route)?, TransitionType? transitionType, PageTransitionType? pageTransitionType, PageTransitionSettings? pageTransitionSettings, dynamic onPop(dynamic value)?}) → Future<void>

Navigate to a new route if a condition is met. If the condition is false, the route will not be navigated to.

routeTo(dynamic routeName, {dynamic data, Map<String, dynamic>? queryParameters, NavigationType navigationType = NavigationType.push, dynamic result, bool removeUntilPredicate(Route route)?, TransitionType? transitionType, PageTransitionType? pageTransitionType, PageTransitionSettings? pageTransitionSettings, int? tabIndex, dynamic onPop(dynamic value)?}) → Future<void>

Navigate to a new route.

routeToAuthenticatedRoute({dynamic data, NavigationType navigationType = NavigationType.pushAndForgetAll, dynamic result, bool removeUntilPredicate(Route route)?, TransitionType? transitionType, PageTransitionType? pageTransitionType, PageTransitionSettings? pageTransitionSettings, dynamic onPop(dynamic value)?}) → Future<void>

Navigate to the auth route.

routeToInitial({dynamic data, NavigationType navigationType = NavigationType.pushAndForgetAll, dynamic result, bool removeUntilPredicate(Route route)?, TransitionType? transitionType, PageTransitionType? pageTransitionType, PageTransitionSettings? pageTransitionSettings, dynamic onPop(dynamic value)?}) → Future<void>

Navigate to the initial route.

session(String name, [Map<String, dynamic> items = const {}]) → NySession

Create a new session

setBadgeNumber(int number) → Future<void>

Set badge number

setupApplication(Map<Type, NyProvider> providers, {bool? enableDebugLogging}) → Future<Nylo>

Sets up application providers.

showAdaptiveDateTimePicker({required BuildContext context, required DateTimeFieldPickerMode mode, DateTimeFieldPickerPlatform? pickerPlatform, DateTime? initialPickerDateTime, DateTime? firstDate, DateTime? lastDate, CupertinoDatePickerOptions cupertinoDatePickerOptions = const CupertinoDatePickerOptions(), MaterialDatePickerOptions materialDatePickerOptions = const MaterialDatePickerOptions(), MaterialTimePickerOptions materialTimePickerOptions = const MaterialTimePickerOptions()}) → Future<DateTime?>

Displays an adaptive date and time picker based on the current platform.

showCupertinoDateTimePicker({required BuildContext context, required DateTimeFieldPickerMode mode, DateTime? initialPickerDateTime, DateTime? firstDate, DateTime? lastDate, CupertinoDatePickerOptions cupertinoDatePickerOptions = const CupertinoDatePickerOptions()}) → Future<DateTime?>

Displays a Cupertino-style date and time picker in a modal popup.

showMaterialDateTimePicker({required BuildContext context, required DateTimeFieldPickerMode mode, DateTime? initialPickerDateTime, DateTime? firstDate, DateTime? lastDate, MaterialDatePickerOptions materialDatePickerOptions = const MaterialDatePickerOptions(), MaterialTimePickerOptions materialTimePickerOptions = const MaterialTimePickerOptions()}) → Future<DateTime?>

Displays a Material-style date and time picker in a modal popup. The context parameter is required to provide the necessary context for the picker. The mode parameter specifies whether to show a date, time, or both date and time picker. The initialPickerDateTime parameter sets the initial date and time to be displayed by the picker.

showNextLog() → void

If you call showNextLog it will force the app to display the next 'NyLogger' log even if your app's APP_DEBUG is set to false.

showToastNotification(BuildContext context, {String id = 'success', String? title, String? description, Map<String, dynamic>? data, Duration? duration, ToastNotificationPosition? position, ToastAnimation? animation, VoidCallback? action, VoidCallback? onDismiss, VoidCallback? onShow}) → void

Display a new Toast notification to the user. Provide a valid toast id (e.g., "success", "warning", "info", "danger") or a custom ID registered via Nylo.addToastNotifications. Set a title and description to personalize the message.

sleep(int seconds, [int microseconds = 0]) → Future<void>

Delays execution for the specified duration.

stateAction(String action, {required dynamic state, dynamic data}) → void

Send a state action to a NyState or NyPage in your application. Provide the state and the action you want to send.

storageCollectionDeleteIndex<T>(String key, int index) → Future<void>

Delete an item from a collection in the storage class.

storageCollectionDeleteValue<T>(String key, {required T value}) → Future<void>

Delete a value from a collection in the storage class.

storageCollectionDeleteWhere<T>(String key, bool value(T where)) → Future<void>

Delete an item from a collection in the storage class.

storageCollectionRead<T>(String key, {Map<Type, dynamic>? modelDecoders}) → Future<List<T>>

Read a collection from the storage class.

storageCollectionSave<T>(String key, List<T> collection) → Future<void>

Save a collection to the storage class.

storageDelete(String key) → Future<void>

Delete data from the storage class.

storageDeleteMultiple(List<String> keys, {bool andFromBackpack = false}) → Future<void>

Delete multiple keys from storage in batch.

storageGetTTL(String key) → Future<Duration?>

Get the remaining time-to-live for a key with expiry.

storageHasKey(String key) → Future<bool>

Check if a key exists in storage.

storageRead<T>(String key, {Map<Type, dynamic>? modelDecoders}) → Future<T?>

Read data from the storage class. Returns the value cast to type T, or null if not found.

storageReadMultiple<T>(List<String> keys, {Map<Type, dynamic>? modelDecoders}) → Future<Map<String, T?>>

Read multiple keys from storage in batch.

storageReadWithExpiry<T>(String key, {T? defaultValue, Map<Type, dynamic>? modelDecoders, bool deleteIfExpired = true}) → Future<T?>

Read data from the storage class, respecting TTL expiration.

storageRemoveExpired() → Future<int>

Remove all expired keys from storage.

storageSave(String key, dynamic object, {bool inBackpack = false}) → Future<void>

Save data to the storage class.

storageSaveAll(Map<String, dynamic> items, {bool inBackpack = false}) → Future<void>

Save multiple key-value pairs to storage in batch.

storageSaveWithExpiry(String key, dynamic object, {required Duration ttl, bool inBackpack = false}) → Future<void>

Save data to the storage class with an expiration time.

testNyPage(String description, {required Widget build(), required Future<void> expectations(WidgetTester tester), bool useSimpleTheme = true, Duration initTimeout = const Duration(seconds: 10), bool skip = false}) → void

Test a NyStatefulWidget page with common assertions.

testNyPageLoading(String description, {required Widget build(), bool skip = false}) → void

Test a NyStatefulWidget's loading state.

textDirectionToAxisDirection(TextDirection textDirection) → AxisDirection

Returns the AxisDirection in which reading occurs in the given TextDirection.

trans(String key, {Map<String, String>? arguments}) → String

Returns the translation value from the key you provide. E.g. trans("hello") lang translation will be returned for the app locale.

updateState<T>(dynamic name, {dynamic data, dynamic setValue(T? currentValue)?}) → void

Update's the state of a NyState Widget in your application. Provide the name of the state and then return a value in the callback setValue.

Typedefs

ChildBuilder = Widget Function(BuildContext context)

Builder function type for creating child widget

CollectionItemBuilder<T> = Widget Function(BuildContext context, CollectionItem<T> item)

Type-safe builder function signature.

CustomAnimationBuilder = Widget Function(BuildContext context, AnimationController controller, Duration duration, Widget child)

Builder method for custom animation.

DecoderBufferCallback = Future<Codec> Function(ImmutableBuffer buffer, {bool allowUpscaling, int? cacheHeight, int? cacheWidth})

Performs the decode process for use in ImageProvider.loadBuffer.

DefaultTransformer = SyncTransformer

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.

DioError = DioException

DioError describes the exception info when a request failed.

DioErrorType = DioExceptionType

Deprecated in favor of DioExceptionType and will be removed in future major versions.

DioExceptionReadableStringBuilder = String Function(DioException e)

The readable string builder's signature of DioException.readableStringBuilder.

DioMediaType = MediaType

The type (alias) for specifying the content-type of the MultipartFile.

EnvContainsKey = bool Function(String key)

Type definition for the env containsKey function.

EnvGetter = dynamic Function(String key, {dynamic defaultValue})

Type definition for the env getter function.

FormValidationResponseBag = List<FormValidationResult>

HeaderForEachCallback = void Function(String name, List<String> values)

The signature that iterates header fields.

HttpClientProvider = HttpClient Function()

Signature for a method that returns an HttpClient.

ImageChunkListener = void Function(ImageChunkEvent event)

Signature for listening to ImageChunkEvent events.

ImageDecoderCallback = Future<Codec> Function(ImmutableBuffer buffer, {TargetImageSizeCallback? getTargetSize})

Performs the decode process for use in ImageProvider.loadImage.

ImageErrorListener = void Function(Object exception, StackTrace? stackTrace)

Signature for reporting errors when resolving images.

ImageListener = void Function(ImageInfo image, bool synchronousCall)

Signature for callbacks reporting that an image is available.

InlineSpanVisitor = bool Function(InlineSpan span)

Called on each span as InlineSpan.visitChildren walks the InlineSpan tree.

InterceptorErrorCallback = void Function(DioException error, ErrorInterceptorHandler handler)

The signature of Interceptor.onError.

InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)

The signature of Interceptor.onRequest.

InterceptorSuccessCallback = void Function(Response response, ResponseInterceptorHandler handler)

The signature of Interceptor.onResponse.

JsonDecodeCallback = FutureOr Function(String)

The callback definition for decoding a JSON string.

JsonEncodeCallback = FutureOr<String> Function(Object)

The callback definition for encoding a JSON object.

MockApiHandler = Future Function(MockApiRequest request)

Handler function type for mock API responses.

ModalShowFunction = Future<T?> Function<T>(BuildContext context, {List<Widget> actionsColumn, EdgeInsets? actionsPadding, List<Widget> actionsRow, Color? backgroundColor, required Widget child, Color? closeButtonColor, Color? closeButtonIconColor, EdgeInsets? contentPadding, bool enableDrag, Color? handleColor, Widget? header, EdgeInsets? headerPadding, double? height, bool isDismissible, bool isScrollControlled, Color? modalBackgroundColor, BoxDecoration? modalDecoration, bool showCloseButton, bool showHandle, bool useRootNavigator, bool useSafeArea})

Type definition for the NyBaseModal.show method. Use this to preserve type information when creating references to the show method.

NyFieldBuilder = Widget Function(BuildContext context, dynamic onChanged(dynamic value), dynamic currentValue, dynamic setState())

Typedef for the builder function used by Field.builder.

NyFieldBuilderLegacy = Widget Function(BuildContext context, dynamic onChanged(dynamic value), dynamic currentValue)

Legacy typedef without setState parameter. Kept for backward compatibility with existing Field.builder callbacks.

NyLogCallback = void Function(NyLogEntry entry)

Callback type for log listeners.

NyRouterRouteBuilder = Widget Function(BuildContext context, NyArgument? args, NyQueryParameters? queryParameters)

The typedef for the route builder.

NyRouteView = Widget Function(BuildContext context)

Painter = void Function(PaintingContext context, Offset offset)

/ A signature for a function that paints with a PaintingContext.

PaintImageCallback = void Function(ImageSizeInfo info)

Called when the framework is about to paint an Image to a Canvas with an ImageSizeInfo that contains the decoded size of the image as well as its output size.

ProgressCallback = void Function(int count, int total)

The type of a progress listening callback when sending or receiving data.

PushNotification = LocalNotification

Backwards compatibility alias for LocalNotification.

PushNotificationAttachments = NotificationAttachment

Backwards compatibility alias for NotificationAttachment.

RequestEncoder = FutureOr<List<int>> Function(String request, RequestOptions options)

The type of a request encoding callback.

RequestHeaders = Map<String, dynamic>

Typedef for RequestHeaders

ResponseDecoder = FutureOr<String?> Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)

The type of a response decoding callback.

RouteView = (String, Widget Function(BuildContext context))

Type definition for the route view.

ShaderWarmUpImageCallback = bool Function(Image image)

The signature of debugCaptureShaderWarmUpImage.

ShaderWarmUpPictureCallback = bool Function(Picture picture)

The signature of debugCaptureShaderWarmUpPicture.

SkeletonizerPainter = void Function(SkeletonizerPaintingContext context, Rect paintBounds, Painter paint, TextDirection? textDirection)

A signature for a function that paints with a SkeletonizerPaintingContext.

SoldColorEffect = SolidColorEffect

backward compatibility typedef for SolidColorEffect

StorageKey = String

StorageKey typedef

ToastOnInitStateCallback = dynamic Function(Duration toastDuration, Duration animDuration)

Callback for the toast widget's initState lifecycle hook. Receives the toast display duration and animation animDuration.

ToastStyleDataFactory = ToastStyleFactory Function(Map<String, dynamic> data)

Typedef for a data-aware toast style factory. Receives a data map and returns a ToastStyleFactory. This allows toast styles to use dynamic data passed at call time.

ToastStyleFactory = Widget Function(ToastMeta meta, void updateMeta(ToastMeta))

Typedef for toast style factory function. The factory receives the ToastMeta and an updateMeta callback to allow the widget to update position, duration, etc.

TransitionPageBuilder = Widget Function(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation)

Builder function type for creating the transition page

ValidateStatus = bool Function(int? status)

The type of a response status code validate callback.

VoidCallback = void Function()

Signature of callbacks that have no arguments and return no data.

Exceptions / Errors

DioException

DioException describes the exception info when a request failed.

NetworkImageLoadException

The exception thrown when the HTTP request to load a network image fails.

NotificationException

Exception thrown when a notification operation fails.

NotNullableError<T>

A TypeError thrown by _checkNotNullable.

RouteNotFoundError

StorageDeserializationException

Exception thrown when deserialization of stored data fails.

StorageException

Base exception class for storage-related errors.

StorageKeyNotFoundException

Exception thrown when a storage key is not found.

StorageSerializationException

Exception thrown when serialization of an object to storage fails.

StorageTimeoutException

Exception thrown when a storage operation times out.