lazyui library
The lazyui
library.
This library provides a collection of commonly used widgets, utilities, and extensions for Flutter app development. Its goal is to accelerate the development process by offering ready-to-use solutions for common tasks.
Classes
- AccordionController
- AndroidBuildVersion
-
Version values of the current Android operating system build derived from
android.os.Build.VERSION
. - AndroidDeviceInfo
-
Information derived from
android.os.Build
. - AndroidDisplayMetrics
- Details for the current display
- AppThemeData
- BaseClient
- The abstract base class for an HTTP client.
- BaseDeviceInfo
- The base class for platform's device info.
- BaseRequest
- The base class for HTTP requests.
- BaseResponse
- The base class for HTTP responses.
- BaseResponseWithUrl
- A BaseResponse with a url field.
- BgCard
- Bidi
- This provides utility methods for working with bidirectional text. All of the methods are static, and are organized into a class primarily to group them together for documentation and discoverability.
- BidiFormatter
- Bidi stands for Bi-directional text. According to Wikipedia: Bi-directional text is text containing text in both text directionalities, both right-to-left (RTL) and left-to-right (LTR). It generally involves text containing different types of alphabets, but may also refer to boustrophedon, which is changing text directionality in each row.
- Bindings
-
The Bindings class provides helper methods for interacting with
WidgetsBinding
. - BlinkAnimate
- A StatelessWidget that provides a blinking animation effect to its child.
- Bot
-
The
Bot
class provides a method for sending messages using the Telegram Bot API. - BottomInlineStyle
- Style configuration for the bottom inline keypad.
- BounceScroll
- BounceScroll is a custom Flutter ScrollPhysics class that enhances scroll behavior by providing a bouncing effect when the scroll reaches its limits. It is particularly useful when you want to add a realistic bouncing behavior to your scrollable widgets.
- Br
- ButtonState
- Represents the state of a button and provides methods to interact with it.
- Bx
- A class providing a utility method for creating box shadows.
- BytesLoader
- An interface that can be implemented to support decoding vector graphic binary assets from different byte sources.
- ByteStream
- A stream of chunks of bytes representing a single piece of data.
- Caa
- A class providing constants for cross axis alignments.
- Cache
- The cache for decoded SVGs.
- CachedNetworkImage
- Image widget to show NetworkImage with caching functionality.
- CachedNetworkImageProvider
- IO implementation of the CachedNetworkImageProvider; the ImageProvider to load network images using a cache.
- CenterDialog
- A widget that displays a dialog centered within the screen.
- Chain
- A chain of stack traces.
- Checkbox
- CheckboxStyle
- A class representing the style properties for checkboxes.
- CirclePainter
- Creating a Circular painter for clipping the rects and creating circle shape
- Client
- The interface for HTTP clients that take care of maintaining persistent connections across multiple requests to the same server.
- ColorMapper
- A class that transforms from one color to another during SVG parsing.
- ConfirmButton
- CupertinoPickerWidget
- CustomTargetContentPosition
- CustomTrackShape
- DateFormat
- DateFormat is for formatting and parsing dates in a locale-sensitive manner.
- DatePickerStyle
- Style configuration for the date picker.
- DefaultSvgTheme
- The SVG theme to apply to descendant SvgPicture widgets which don't have explicit theme values.
- Device
- A class representing a device with brand, model, system, SDK, and ID information.
- DeviceInfoPlugin
- Provides device and operating system information.
- DeviceInfoPlusLinuxPlugin
-
See
DeviceInfoPlatform
- DeviceInfoPlusWindowsPlugin
-
The Windows implementation of
DeviceInfoPlatform
. - DownloadProgress
- Progress of the file that is being downloaded from the originalUrl.
- DropOption
- Represents an option in a dropdown menu.
- DropStyle
- Represents the style configuration for a dropdown menu.
- DropValue
- Represents a single dropdown value with a label and corresponding value.
- Ei
- ErrorInfo
- ErrorInfo Class
- Errors
- Faker
-
The
Faker
class provides methods for generating random text content. - Formatter
-
The
InputFormat
class provides a set of predefined input formatters for text input fields. - FormMessage
- A class representing messages for different types of form validations.
- FormModel
- A model class representing a form.
- FormStyle
- A class representing the style properties for a form.
- Frame
- A single stack frame. Each frame points to a precise location in Dart code.
- Fw
- A class providing constants for font weights.
- Gfont
-
The
Gfont
class provides a set of predefined text styles and methods for customizing text styles in your application. - GoogleFonts
- Provides configuration, and static methods to obtain TextStyles and TextThemes.
- Iconr
- A widget that displays an icon with various customization options.
- IconStyle
- Represents a set of style properties for an icon.
- InkTouch
- A widget that simplifies the use of InkWell in Flutter with customizable options.
- Input
- InputStyle
- A class representing the style properties for an input field.
- Intl
-
The Intl class provides a common entry point for internationalization
related tasks. An Intl instance can be created for a particular locale
and used to create a date format via
anIntl.date()
. Static methods on this class are also used in message formatting. - Intrinsic
- A widget that sizes its child to its intrinsic size, optionally allowing it to expand in a specific axis.
- IosDeviceInfo
-
Information derived from
UIDevice
. - IosUtsname
-
Information derived from
utsname
. See http://pubs.opengroup.org/onlinepubs/7908799/xsh/sysutsname.h.html for details. - La
- A class providing access to LineAwesomeIcons font family.
- LazyUi
- LineProgressIndicator
- A customizable linear progress indicator widget with animation support.
- LinuxDeviceInfo
- Device information for a Linux system.
- Lipsum
- A class for generating random text.
- LzAccordion
- A widget that displays a list of collapsible panels, allowing users to expand or collapse content sections.
- LzAccordionContent
- LzBadge
- A badge widget to display textual or icon-based information.
- LzButton
- A customizable button widget with support for text, icons, and various styles.
- LzButtonStyle
- A class representing the style configuration for a button.
- LzCard
- A card widget with customizable content.
- LzConfirm
- Utility class for displaying confirmation dialogs or sheets.
- LzContextModifiers
- A class for applying Lazuli UI context modifiers to a build context.
- LzDatePicker
- A date picker widget for selecting dates.
- LzDrop
- A utility class for displaying dropdown menus.
- LzDropItem
- A dropdown item widget that displays a list of options when tapped.
-
LzDropView<
T> - An abstract class for creating dropdown view widgets.
- LzForm
- LzFormWrap
-
LzImage<
T> - A widget for displaying an image.
-
LzListener<
T> - A widget that listens for changes in a specified key and rebuilds accordingly.
- LzListView
- It allows you to quickly create scrollable lists of child widgets and provides options for customizing the scrolling behavior and appearance.
- LzLoader
-
LzLoader
is a versatile Flutter widget that provides a loading indicator. It can be customized by specifying the size, stroke width, margin, and color. - LzModifiers
- A class for applying Lazuli UI modifiers to a widget.
- LzNoData
- A widget displayed when there is no data.
-
LzNotifier<
T> - A class representing a notifier for value changes.
- LzOption
- A widget for displaying dynamic menus with optional associated widgets triggered upon selection.
- LzOptionNotifier
- Notifier class for managing state and actions of the LzOption widget.
- LzPad
- This class provides a utility for displaying a numeric keypad widget.
- LzPadHeader
- LzPadHeader widget for the keypad.
- LzPicker
- Displays a picker with options.
- LzSlideIndicator
- LzSlideIndicator is a Flutter widget used to display a row of indicators typically used for indicating the current page or position within a set of items or slides. It allows customization of the appearance and behavior of the indicators.
- LzState
- A class providing static methods for managing state and listening to changes.
- LzTextDivider
- A divider widget with text.
- LzTextField
- LzTextField is a customizable Flutter widget that simplifies the creation of text input fields with various features such as keyboard type, input actions, character limits, and more.
- LzTheme
- LzToast
- LzToastConfig
- Configuration options for LzToast messages.
- Maa
- A class providing constants for main axis alignments.
- MacOsDeviceInfo
- Object encapsulating MACOS device information.
- Mas
- A class providing constants for main axis sizes.
- MicroMoney
- Used primarily for currency formatting, this number-like class stores millionths of a currency unit, typically as an Int64.
- MultiImageStreamCompleter
- An ImageStreamCompleter with support for loading multiple images.
- MultipartFile
- A file to be uploaded as part of a MultipartRequest.
- MultipartRequest
-
A
multipart/form-data
request. - NetworkError
- NetworkError Class
- None
- None is a convenient shortcut for creating an empty, zero-sized box using SizedBox.shrink(). It allows you to quickly create a widget that takes up no space in your layout.
- Number
- NumberFormat
- Provides the ability to format a number in a locale-specific way.
- Option
- A model class representing an option.
- OptionMenu
- Represents a menu option with a label, optional widget, icon, and onTap callback.
- PadController
- Controller for managing the keypad.
- PadStyle
- Style configuration for the keypad widget.
- PadWidget
- Widget for displaying the numeric keypad.
- PickerStyle
- Represents the style configuration for a picker.
- PictureInfo
- The deocded result of a vector graphics asset.
- PictureProvider
- Deprecated class, will be removed, does not do anything.
- Poslign
- Poslign is a Flutter widget that allows precise control over the positioning and alignment of its child widget within a container. It combines the power of Positioned, IgnorePointer, Align, and Container widgets to achieve this.
- Radio
- RadioStyle
- A class representing the style properties for radio buttons.
- RadioValue
- A model class representing a radio button value.
- Refreshtor
- A widget that displays a refresh indicator.
- RefreshtorStyle
- Style configuration for Refreshtor widget.
- Request
- An HTTP request where the entire request body is known in advance.
- ResizedSwitched
- A widget that animates the resizing and switching of its child widget.
- Response
- An HTTP response where the entire response body is known in advance.
- Ribbon
- RippleAnimation
- When you don't need to provide any child, you can use any widget as the child parameter. If no child is needed, simply provide an empty Container(). The delay parameter utilizes a Timer to delay the animation, and its default value is zero. To create a pulsing effect, you can set the repeat parameter to true.
- RippleAnimationState
- state of the animation
- Rotator
- A widget that rotates its child by a specified degree over a given duration.
- ScaleSwitched
- A widget that animates the scaling and switching of its child widget.
- Scroller
- ScrollGlowless
- ScrollGlowless is a Flutter widget that wraps its child with a ScrollConfiguration using the Unglow behavior, preventing the scroll glow effect.
- Select
- Shimmer
- A widget renders shimmer effect over child widget tree.
- Skeleton
- Skeleton widget used for displaying loading or placeholder content.
- SlideDown
- A widget that animates the sliding down of its child widget.
- SlideLeft
- A widget that animates the sliding effect from the right to the left of its child widget.
- Slider
- SlideRight
- A widget that animates the sliding effect from the left to the right of its child widget.
- SlideStyle
- A class representing the style properties for a slide (slider).
- SlideSwitched
- A widget that animates the sliding effect of its child widget with optional opacity transition.
- SlideUp
- A widget that animates the sliding effect from the bottom to the top of its child widget.
- StreamedRequest
- An HTTP request where the request body is sent asynchronously after the connection has been established and the headers have been sent.
- StreamedResponse
- An HTTP response where the response body is received asynchronously after the headers have been received.
- Svg
-
A utility class for decoding SVG data to a
DrawableRoot
or a PictureInfo. - SvgAssetLoader
- A BytesLoader that decodes and parses an SVG asset in an isolate and creates a vector_graphics binary representation.
- SvgBytesLoader
- A BytesLoader that decodes and parses a UTF-8 encoded SVG string from a Uint8List in an isolate and creates a vector_graphics binary representation.
- SvgCacheKey
- A SvgTheme aware cache key.
- SvgFileLoader
- A BytesLoader that decodes SVG data from a file in an isolate and creates a vector_graphics binary representation.
-
SvgLoader<
T> - A BytesLoader that parses a SVG data in an isolate and creates a vector_graphics binary representation.
- SvgNetworkLoader
- A BytesLoader that decodes and parses a UTF-8 encoded SVG string the network in an isolate and creates a vector_graphics binary representation.
- SvgPicture
- A widget that will parse SVG data for rendering on screen.
- SvgStringLoader
- A BytesLoader that parses an SVG string in an isolate and creates a vector_graphics binary representation.
- SvgTheme
- A theme used when decoding an SVG picture.
- SwitchStyle
- A class representing the style properties for a switch.
- Ta
- A class providing constants for text alignments.
- TablerIconData
- TablerIconData is a base class for all Tabler Icons. It is used to generate the TablerIcons class.
- Target
- Defines the properties of a target for the tutorial.
- TargetContent
- TargetFocus
- TargetPosition
- TEC
-
TEC
- A utility class for creatingTextEditingController
instances. - TecValidation
-
TecValidation
- A class to handle validation results in technical processes. - TextDirection
- Represents directionality of text.
- Textml
-
Textml
is a Flutter widget for rendering rich text with custom formatting. It allows you to define text styles, alignment, text direction, and supports basic HTML-like formatting tags such asb
,i
,u
, andcolor
. - Textr
-
Textr
is a versatile text widget in Flutter that supports custom styling, text alignment, and optional icon placement. It simplifies the creation of text with icons while providing extensive customization options. - Ti
- Time
- Represents a time with hours and minutes.
- TimePicker
- TimePickerStyle
- Styling options for the TimePicker widget.
- Tints
- Tit
- A class providing constants for text input types.
- Tof
- A class providing constants for text overflow behaviors.
- Touch
- Trace
- A stack trace, comprised of a list of stack frames.
- Trainer
- A widget that provides a guided tour experience by highlighting specific UI elements.
- TrainerController
- Controller for managing the visibility of the trainer.
- TrainerStyle
- Style configuration for the Trainer widget.
- TrianglePainter
- TutorialCoachMark
- TutorialCoachMarkController
- Unglow
- Unglow is a Flutter ScrollBehavior that prevents the scroll glow effect typically seen when reaching the scroll limits. It allows you to create a scrollable widget without the built-in overscroll indicator.
- UnparsedFrame
- A frame that failed to parse.
- Utils
- VectorGraphicUtilities
- Utility functionality for interaction with vector graphic assets.
- Wa
- A class providing constants for wrap alignments.
- Wca
- A class providing constants for wrap cross axis alignments.
- WebBrowserInfo
-
Information derived from
navigator
. - WindowsDeviceInfo
- Object encapsulating WINDOWS device information.
- Wrapper
- Wrapper is a versatile Flutter widget that provides a convenient way to wrap child widgets. It includes features like handling background taps to dismiss the keyboard and controlling the back button press behavior. This widget simplifies common wrapping tasks in Flutter apps.
- ZoomIn
- A widget that animates the zoom-in effect of its child widget.
Enums
- AppTheme
- Enum representing different application themes.
- BrowserName
- List of supported browsers
- CacheManagerLogLevel
- Log levels of the cache manager. Debug shows failed downloads and verbose also shows successful downloads and cache retrievals.
- ConfirmType
- Enumeration representing different types of confirmation dialogs.
- ContentAlign
- DropAlignment
- Enumerates the alignment options for the dropdown menu relative to its anchor.
- FormAlert
- Enumeration representing different types of form alerts.
- FormType
- Enumeration representing different types of form layouts.
- IconType
- Enum representing types of icons used in the application.
- LogColor
- Enum representing different log colors.
- PadType
- Enumeration for the type of keypad.
- RefrehtorType
- Enum representing different types of refresh indicators in the application.
- ShapeLightFocus
- ShimmerDirection
-
- author: hunghd
- email: hunghd.yb@gmail.com
- SlideDirection
- Enum representing slide directions for animations in the application.
- StackAlign
- StorageDirectory
-
Corresponds to constants defined in Androids
android.os.Environment
class. - ToastPlacement
- Enum defining the placement options for displaying a toast.
Extensions
- CustomColorExtension on Color
- CustomColumnExtension on Column
- CustomIconExtension on Icon
- Extends the functionality of the Icon class with an additional method.
- CustomIconrExtension on Iconr
- Extends the functionality of the Iconr class with an additional method.
-
CustomListWidgetExtension
on List<
Widget> - Extension method on List<Widget> to conditionally replace the list with a skeleton list.
- CustomRowExtension on Row
- DateTimeExtension on DateTime
- Extends the functionality of the DateTime class with additional methods.
- HeadersWithSplitValues on BaseResponse
-
ListNumExtension
on List<
num> - Extends the functionality of the List<num> class with additional methods and properties.
- LzBoolExtension on bool
- Extends the functionality of the bool class with additional methods.
- LzButtonExtension on LzButton
- Extension providing utility methods for customizing LzButton widgets.
- LzColorExtension on Color
- An extension on the Color class that provides additional functionality.
- LzContextExtension on BuildContext
- Extends the functionality of the BuildContext class with additional methods and properties.
- LzContextModifierExtension on BuildContext
- Extension method on BuildContext to provide access to Lazuli UI context modifiers.
- LzDateTimeNullableExtension on DateTime?
- Extends the functionality of the DateTime? class with additional methods.
- LzDoubleExtension on double
- LzDynamicExtension on T?
- Extension method to provide a fallback value if the object is null or meets certain conditions. This extension can be applied to any data type.
- LzExtension on Widget
- Extension method on Widget to provide access to Lazuli UI modifiers.
-
LzFormExtension
on Map<
String, FormModel> -
LzGlobalKeyExtension
on GlobalKey<
State< StatefulWidget> > - Extends the functionality of the GlobalKey class with additional methods.
-
LzIconButtonExtension
on List<
IconData> - LzIntExtension on int
- Extends the functionality of the int class with additional methods.
- LzIntNullableExtension on int?
- Extension method on int? to format the value as a currency string.
- LzListenableExtension on T
-
Extends the functionality of classes that extend
ChangeNotifier
with an additional method. -
LzListExtension
on List<
T> - Extends the functionality of the List<T> class with additional methods and properties.
-
LzListMapExtension
on List<
Map> - Extends the functionality of the List<Map> class with additional methods and properties.
-
LzListStringExtension
on List<
String> - Extends the functionality of the List<String> class with additional methods and properties.
-
LzMapTextEditingControllerExtension
on Map<
String, TextEditingController> - Extends the functionality of a map containing TextEditingController objects.
- LzNullableStringExtension on String?
-
LzRangeIteration
on List<
int> - Extends the functionality of the List<int> class with additional methods.
- LzStringExtension on String
- Extends the functionality of the String class with additional methods.
- LzTextFieldExtension on LzTextField
- Extension method on LzTextField to create a bordered version of the text field.
- LzWidgetExtension on Widget
-
MapStringExtension
on Map<
String, dynamic> -
Extends the functionality of a map with keys of type String and values of type
dynamic
. -
MapTextEditingControllerExtension
on Map<
String, TextEditingController> -
Extension
MapTextEditingControllerExtension
onMap<String, TextEditingController>
- NullableExt on T?
-
OptionExtension
on List<
String> - Extension methods for working with lists of strings to generate options.
- SkeletonExtension on Skeleton
-
StateExt
on State<
StatefulWidget> - TextEditingControllerExtension on String
-
Extension
TextEditingControllerExtension
onString
- TextStyleExtension on TextStyle
-
The
TextStyleExtension
extension provides a set of convenience methods for extending the functionality of theTextStyle
class in Flutter.
Constants
- vg → const VectorGraphicUtilities
- The VectorGraphicUtilities instance.
Properties
- disablePathProviderPlatformOverride ← bool
-
no getter
- gfont ↔ TextStyle
-
getter/setter pair
- lzDarkMode ↔ bool
-
getter/setter pair
- svg → Svg
-
Instance for Svg's utility methods, which can produce a
DrawableRoot
or PictureInfo from String or Uint8List.final - timeDilation → double
-
Slows down animations by this factor to help in development.
no setter
-
words
↔ List<
String> -
word list to generate random text
getter/setter pair
Functions
-
colorize(
String value, LogColor color) → String -
Colorizes the given
value
with the specifiedcolor
. -
delete(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP DELETE request with the given headers to the given URL.
-
get(
Uri url, {Map< String, String> ? headers}) → Future<Response> - Sends an HTTP GET request with the given headers to the given URL.
-
getApplicationCacheDirectory(
) → Future< Directory> - Path to a directory where the application may place application-specific cache files.
-
getApplicationDocumentsDirectory(
) → Future< Directory> - Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
-
getApplicationSupportDirectory(
) → Future< Directory> - Path to a directory where the application may place application support files.
-
getDownloadsDirectory(
) → Future< Directory?> - Path to the directory where downloaded files can be stored.
-
getExternalCacheDirectories(
) → Future< List< Directory> ?> - Paths to directories where application specific cache data can be stored externally.
-
getExternalStorageDirectories(
{StorageDirectory? type}) → Future< List< Directory> ?> - Paths to directories where application specific data can be stored externally.
-
getExternalStorageDirectory(
) → Future< Directory?> - Path to a directory where the application may access top level storage.
-
getLibraryDirectory(
) → Future< Directory> - Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
-
getTargetCurrent(
TargetFocus target, {bool rootOverlay = false}) → TargetPosition? -
getTemporaryDirectory(
) → Future< Directory> - Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
-
head(
Uri url, {Map< String, String> ? headers}) → Future<Response> - Sends an HTTP HEAD request with the given headers to the given URL.
-
logg(
dynamic value, {LogColor color = LogColor.yellow, int limit = 500, String? name, bool nolimit = false}) → void - Prints a log message with optional color, length limit, and name.
-
logs(
List values, {LogColor color = LogColor.yellow, int limit = 500, String? name}) → void - Prints a list of log messages with optional color, length limit, and name.
-
patch(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP PATCH request with the given headers and body to the given URL.
-
post(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP POST request with the given headers and body to the given URL.
-
postFrame(
VoidCallback callback) → void -
printt(
dynamic value) → void -
Custom print function for development use only.
Uses
assert
to ensure the print statement only executes in debug mode. In release mode, this function does nothing. -
put(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> - Sends an HTTP PUT request with the given headers and body to the given URL.
-
read(
Uri url, {Map< String, String> ? headers}) → Future<String> - Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
-
readBytes(
Uri url, {Map< String, String> ? headers}) → Future<Uint8List> - Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
-
runWithClient<
R> (R body(), Client clientFactory(), {ZoneSpecification? zoneSpecification}) → R -
Runs
body
in its own Zone with the Client returned byclientFactory
set as the default Client. -
toBeginningOfSentenceCase(
String? input, [String? locale]) → String? - Convert a string to beginning of sentence case, in a way appropriate to the locale.
Typedefs
- ChainHandler = void Function(dynamic error, Chain chain)
- A function that handles errors in the zone wrapped by Chain.capture.
-
ImageWidgetBuilder
= Widget Function(BuildContext context, ImageProvider<
Object> imageProvider) - Builder function to create an image widget. The function is called after the ImageProvider completes the image loading.
- LoadingErrorWidgetBuilder = Widget Function(BuildContext context, String url, Object error)
- Builder function to create an error widget. This builder is called when the image failed loading, for example due to a 404 NotFound exception.
- PlaceholderWidgetBuilder = Widget Function(BuildContext context, String url)
- Builder function to create a placeholder widget. The function is called once while the ImageProvider is loading the image.
- ProgressIndicatorBuilder = Widget Function(BuildContext context, String url, DownloadProgress progress)
- Builder function to create a progress indicator widget. The function is called every time a chuck of the image is downloaded from the web, but at least once during image loading.
- TargetContentBuilder = Widget Function(BuildContext context, TutorialCoachMarkController controller)
Exceptions / Errors
- ClientException
- An exception caused by an error in a pkg/http client.
- MissingPlatformDirectoryException
- An exception thrown when a directory that should always be available on the current platform cannot be obtained.
- NotFoundTargetException