forui library

A Flutter package for building beautiful user interfaces.

Classes

$FAssetsIcons
Contains the assets and nested directories in the assets/icons directory.
Asset
An asset in a Flutter project's assets directory.
FAccordion
A vertically stacked set of interactive headings that each reveal a section of content.
FAccordionController
A controller that controls which sections are shown and hidden.
FAccordionItem
An interactive heading that reveals a section of content.
FAccordionStyle
The FAccordion's style.
FAlert
An alert.
FAlertCustomStyle
A custom FAlert style.
FAlertStyle
A FAlert's style.
FAlertStyles
FAlertCustomStyle's style.
FAssets
Contains the assets and nested directories in the assets directory.
FAvatar
An image element with a fallback for representing the user.
FAvatarStyle
FAvatar's style.
FBadge
A badge. Badges are typically used to draw attention to specific information, such as labels and counts.
FBadgeContentStyle
FBadge content's style.
FBadgeStyle
A FBadge's style.
FBadgeStyles
The FBadgeStyles.
FBaseBadgeStyle
A FBadge's style.
FBaseButtonStyle
A FButton's style.
FBottomNavigationBar
A bottom navigation bar.
FBottomNavigationBarData
A FBottomNavigationBar]'s data.
FBottomNavigationBarItem
A FBottomNavigationBar item.
FBottomNavigationBarItemStyle
FBottomNavigationBarItem's style.
FBottomNavigationBarStyle
FBottomNavigationBar's style.
FBreadcrumb
A breadcrumb.
FBreadcrumbItem
A breadcrumb item.
FBreadcrumbStyle
The FBreadcrumb styles.
FBreakpoints
The responsive breakpoints based on Tailwind CSS.
FButton
A button.
FButtonContentStyle
FButton content's style.
FButtonData
A button's data.
FButtonIconContentStyle
FButton icon content's style.
FButtonSpinner
An animated spinner icon.
FButtonSpinnerStyle
FButton spinner's style.
FButtonStyle
A custom FButton style.
FButtonStyles
FButtonStyle's style.
FCalendar
A calendar.
FCalendarController<T>
A controller that controls date selection in a calendar.
FCalendarDayPickerStyle
A day picker's style.
FCalendarDayStyle
A calender day's style.
FCalendarEntryStyle
A calendar entry's style.
FCalendarHeaderStyle
The calendar header's style.
FCalendarStyle
The calendar's style.
FCalendarYearMonthPickerStyle
The year/month picker's style.
FCard
A card.
FCardContentStyle
FCard content's style.
FCardStyle
FCard's style.
FChangeNotifier
A ChangeNotifier that provides additional life-cycle tracking capabilities.
FCheckbox
A checkbox control that allows the user to toggle between checked and not checked.
FCheckboxErrorStyle
A checkbox's error state style.
FCheckboxSelectGroupStyle
A FSelectGroupItem.checkbox's style.
FCheckboxStateStyle
A checkbox state's style.
FCheckboxStyle
A FCheckbox's style.
FColorScheme
A set of colors that is part of a FThemeData. It is used to configure the color properties of Forui widgets.
FContinuousSliderController
A controller that manages a slider's active track which represents a continuous range/value.
FDateField
A date field allows a date to be selected from a calendar, input field, or both.
FDateFieldCalendarProperties
A date picker calendar popover's properties.
FDateFieldController
The date field's controller.
FDateFieldStyle
A date field's style.
FDefaultLocalizations
The default localization for when no localization is provided.
FDialog
A modal dialog.
FDialogContentStyle
FDialog content's style.
FDialogStyle
FDialog's style.
FDiscreteSliderController
A controller that manages a slider's active track which represents a discrete range/value.
FDivider
A divider.
FDividerStyle
FDivider's style.
FDividerStyles
The FDivider styles.
FFocusedOutline
An outline around a focused widget that does not affect its layout.
FFocusedOutlineStyle
The FFocusedOutline's style.
FFormFieldErrorStyle
A form field's error style.
FFormFieldStyle
A form field state's style.
FHeader
A header contains the page's title and actions.
FHeaderAction
A FHeader action.
FHeaderActionStyle
FHeaderAction's style.
FHeaderData
A header's data.
FHeaderStyles
FHeader's styles.
FIcon
A graphical icon widget that inherits its style from an FIconStyle, if any.
FIconStyle
The default properties of FIcons in a widget subtree.
FIconStyleData
The FIconStyle that this FIconStyleData's widget subtree should inherit.
FLabel
A label that describes a form field with a label, description, and error message (if any).
FLabelLayoutStyle
The FLabel's layout style.
FLabelStateStyles
The FLabel's state styles.
FLabelStyles
The FLabel's styles.
FLineCalendar
A line calendar displays dates in a single horizontal, scrollable line.
FLineCalendarItemStyle
A line calendar item's state style.
FLineCalendarStyle
FLineCalendar's style.
FLocalizations
Callers can lookup localized strings with an instance of FLocalizations returned by FLocalizations.of(context).
FModalSheetRoute<T>
A route that represents a modal sheet. showFSheet should be preferred in most cases.
FMultiSelectGroupController<T>
A FSelectGroupController that allows multiple selections.
FNestedHeaderStyle
FHeader.nested's style.
FPagination
A pagination allows the user to select a specific page from a range of pages.
FPaginationController
A controller that controls which page is selected.
FPaginationStateStyle
A FPagination state's style.
FPaginationStyle
The FPagination styles.
FPersistentSheetController
A sheet controller.
FPicker
A generic picker that allows an item to be selected. It is composed of one or more FPickerWheels, optionally, with separators between those wheels.
FPickerController
A picker's controller.
FPickerStyle
FPickerStyle's style.
FPickerWheel
A picker wheel that displays a list of items that can be scrolled vertically.
FPopover
A popover displays rich content in a portal that is aligned to a child.
FPopoverController
A controller that controls whether a FPopover is shown or hidden.
FPopoverMenu
A popover menu displays a menu in a portal aligned to a child.
FPopoverMenuStyle
A FPopoverMenuStyle's style.
FPopoverStyle
A FPopover's style.
FPortal
A portal renders a portal widget that "floats" on top of a child widget.
FProgress
A progress bar.
FProgressStyle
FProgress's style.
FRadio
A radio button that typically allows the user to choose only one of a predefined set of options.
FRadioErrorStyle
A FRadio's error style.
FRadioSelectGroupController<T>
A FSelectGroupController that allows only one selection, mimicking the behaviour of radio buttons.
FRadioSelectGroupStyle
A FSelectGroupItem.radio's style.
FRadioStateStyle
A FRadio's state style.
FRadioStyle
A FRadio's style.
FResizable
A resizable allows its children to be resized along either the horizontal or vertical main axis.
FResizableController
A controller that manages the resizing of regions in a FResizable.
FResizableDividerStyle
The style of the dividers between FResizableRegions.
FResizableDividerThumbStyle
The style of the dividers' thumbs between FResizableRegions.
FResizableRegion
A resizable region that can be resized along the parent FResizable's axis. It should always be in a FResizable.
FResizableRegionData
A FResizableRegion's data.
FResizableStyle
A FResizable's style.
FRootHeaderStyle
FHeader.new's style.
FScaffold
A scaffold.
FScaffoldStyle
FScaffold's style.
FSelectGroup<T>
A set of items that are treated as a single selection.
FSelectGroupController<T>
A select group's controller that manages the selection state of a group of values.
FSelectGroupErrorStyle
FSelectGroup's error style.
FSelectGroupItem<T>
Represents a selection in a FSelectGroup.
FSelectGroupStateStyle
FSelectGroup's state style.
FSelectGroupStyle
FSelectGroup's style.
FSelectMenuTile<T>
A tile that, when triggered, displays a list of options for the user to pick from.
FSelectMenuTileStyle
A FSelectMenuTileStyle's style.
FSelectTile<T>
A tile that represents a selection in a FSelectTileGroup. It should only be used in a FSelectTileGroup.
FSelectTileGroup<T>
A set of tiles that are treated as a single selection.
FSheets
Sheets that are displayed above its child. It is part of FScaffold, which should be preferred in most cases.
FSheetStyle
A sheet's style.
FSlider
An input where the user selects a value from within a given range.
FSliderController
A controller that manages a slider's active track.
FSliderErrorStyle
A slider error's style.
FSliderMark
A mark in a FSlider. It is a combination of a tick - a visual indicator along the track, and a label.
FSliderMarkStyle
A FSlider mark's style.
FSliderSelection
A FSlider's active track/selection.
FSliderStateStyle
A slider state's style.
FSliderStyle
A slider's style.
FSliderStyles
A slider's styles.
FSliderThumbStyle
A slider thumb's style.
FSliderTooltipsController
The controller for a slider's registered tooltips.
FStyle
A set of miscellaneous properties that is part of a FThemeData.
FSwitch
A control that allows the user to toggle between checked and unchecked.
FSwitchErrorStyle
FSwitch's error style.
FSwitchStateStyle
FSwitch's state style.
FSwitchStyle
FSwitch's style.
FTabController
A controller that controls selection in a FTabs.
FTabEntry
An object that represents a tab entry in a group of tabs.
FTabs
Allows switching between widgets through tabs.
FTabsStyle
FTabs's style.
FTappable
An area that responds to touch.
FTextField
A text field.
FTextFieldBorderStyle
A FTextField border's style.
FTextFieldErrorStyle
A FTextField error state's style.
FTextFieldStateStyle
A FTextField state's style.
FTextFieldStyle
FTextFieldStyle's style.
FTheme
Applies a theme to descendant widgets.
FThemeData
Defines the configuration of the overall visual FTheme for a widget subtree.
FTile
A tile that is typically used to group related information together.
FTileContentStateStyle
A FTile content's state style.
FTileContentStyle
A FTile content's style.
FTileData
A tile's data.
FTileGroup
A tile group that groups multiple FTileMixins and FTileGroupMixins together.
FTileGroupData
A tile group's data.
FTileGroupStyle
A FTileGroup's style.
FTileStyle
A FTile's style.
FTime
Represents the time of the day.
FTimeField
A time field allows a time to be selected from a picker or input field.
FTimeFieldController
The time field's controller.
FTimeFieldStyle
A time field's style.
FTimePicker
A time picker that allows a time to be selected.
FTimePickerController
A FTimePicker's controller.
FTimePickerStyle
The style of a time picker.
FTooltip
A tooltip displays information related to a widget when focused, hovered over and/or long pressed.
FTooltipController
A controller that controls whether a FPopover is shown or hidden.
FTooltipStyle
A FTooltip's style.
FTypography
Definitions for the various typographical styles that are part of a FThemeData.
FValueNotifier<T>
A ValueNotifier that provides additional life-cycle tracking capabilities.
GenericAsset
A default asset for file extensions not directly supported by the other Assets.
ImageAsset
An image.
LottieAsset
A Lottie animation.
SvgAsset
An SVG file.

Enums

FCalendarPickerType
The current picker type.
FHidePopoverRegion
The regions that can be tapped to hide a popover.
FLabelState
The label's state.
FLayout
Possible way to layout a sequence of items.
FResizableDivider
The appearance of dividers between FResizableRegions.
FSliderInteraction
Possible ways for a user to interact with a slider.
FTabBarIndicatorSize
Defines how the bounds of the selected tab indicator are computed.
FTileDivider
The divider between tiles in a group.

Mixins

FFormFieldProperties<T>
A form field's properties.
FPickerWheelMixin
A marker interface that indicates that a widget is a picker wheel.
FTileGroupMixin<T extends Widget>
A marker interface which denotes that mixed-in widgets can group tiles and be used in a _MergeTileGroups.
FTileMixin
A marker interface which denotes that mixed-in widgets can be used in a FTileGroup.
FTransformable
A marker interface that denotes that mixed-in types are transformable.

Extensions

FDateTimeLocalizations on FLocalizations
Localizations for date and time formatting.
FPortalShift on Never
Provides various portal shifting strategies for when a portal overflows out of the viewport.
FThemeBuildContext on BuildContext
Provides functions for accessing the current FThemeData.
FThemes on Never
The Forui themes.
FTransformables on T
Provides functions to transform a T using a given function.
ImageAssetExtension on ImageAsset
Provides functions for converting an ImageAsset to a Flutter Image.
SvgAssetExtension on SvgAsset
Provides functions for converting an SvgAsset to a SvgPicture.

Constants

scriptPeriods → const List<String>
The locales which period is written in a script that requires composing:

Functions

lookupFLocalizations(Locale locale) → FLocalizations
showFPersistentSheet({required BuildContext context, required FLayout side, required Widget builder(BuildContext, FPersistentSheetController), FSheetStyle? style, double? mainAxisMaxRatio = 9 / 16, BoxConstraints constraints = const BoxConstraints(), bool draggable = true, Offset? anchorPoint, bool useSafeArea = false, bool keepAliveOffstage = false, Key? key}) → FPersistentSheetController
Shows a persistent sheet that appears above the current widget. It should have a FSheets or FScaffold ancestor.
showFSheet<T>({required BuildContext context, required WidgetBuilder builder, required FLayout side, bool useRootNavigator = false, FSheetStyle? style, double? mainAxisMaxRatio = 9 / 16, String? barrierLabel, bool barrierDismissible = true, BoxConstraints constraints = const BoxConstraints(), bool draggable = true, RouteSettings? routeSettings, AnimationController? transitionAnimationController, Offset? anchorPoint, bool useSafeArea = false}) → Future<T?>
Shows a modal sheet that appears from the given side.

Typedefs

FCalendarDayData = ({bool current, DateTime date, bool selectable, bool selected, FCalendarDayPickerStyle style, bool today})
A calendar day's data.
FLabelStyle = ({FLabelLayoutStyle layout, FLabelStateStyles state})
The FLabel's style.
FLineCalendarItemData = ({DateTime date, bool focused, bool hovered, FLineCalendarItemStyle itemStyle, bool selected, FLineCalendarStyle style, bool today})
The state of a line calendar item used to build a line calendar item.
FPortalBox = ({Alignment anchor, Size size})
A portal's rectangle.
FPortalChildBox = ({Alignment anchor, Offset offset, Size size})
A portal child's rectangle.
FSelectGroupItemState<T> = ({FSelectGroupController<T> controller, bool selected, FSelectGroupStyle style, T value})
A FSelectGroupItem's state.
FTappableData = ({bool focused, bool hovered})
The tappable's current data.
FTextFieldCounterBuilder = Widget? Function(BuildContext context, int currentLength, int? maxLength, bool focused)
The FTextField.counterBuilder callback.