Forui

https://pub.dev/documentation/forui/latest/
Admin
Forui is a customizable, minimalistic Flutter UI library heavily inspired by shadcn/ui that provides...
Tokens:1,217,066
Snippets:10,015
Trust Score:9.9
Update:20 hours ago
Show doc for...
Tokens:
Raw
### siblingRange property

Source: https://pub.dev/documentation/forui/latest/forui.widgets.pagination/FPaginationController-class.html

Gets the start and end pages to display around the current page.

```APIDOC
## siblingRange → (int, int)

### Description
Gets the start and end pages to display around the current page.

### Type
(int, int)

### Access
Getter only.
```

--------------------------------

### FBottomNavigationBarItem constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.bottom_navigation_bar/FBottomNavigationBarItem-class.html

Creates a FBottomNavigationBarItem with the required icon and optional label, semanticsLabel, style, autofocus, focusNode, and callbacks.

```APIDOC
## FBottomNavigationBarItem({required Widget icon, Widget? label, String? semanticsLabel, FBottomNavigationBarItemStyleDelta style = const .context(), bool autofocus = false, FocusNode? focusNode, ValueChanged<bool>? onFocusChange, ValueChanged<bool>? onHoverChange, FTappableVariantChangeCallback? onVariantChange, Key? key})

### Description
Creates a FBottomNavigationBarItem widget. The icon is required, while label, semanticsLabel, style, autofocus, focusNode, and various callbacks are optional.

### Parameters
- **icon** (Widget) - Required - The icon widget to display.
- **label** (Widget?) - Optional - The label widget to display.
- **semanticsLabel** (String?) - Optional - The semantics label for accessibility.
- **style** (FBottomNavigationBarItemStyleDelta) - Optional - The style delta for the item, defaults to const .context().
- **autofocus** (bool) - Optional - Whether the item should autofocus, defaults to false.
- **focusNode** (FocusNode?) - Optional - The focus node for the item.
- **onFocusChange** (ValueChanged<bool>?) - Optional - Callback when focus changes.
- **onHoverChange** (ValueChanged<bool>?) - Optional - Callback when hover changes.
- **onVariantChange** (FTappableVariantChangeCallback?) - Optional - Callback when variant changes.
- **key** (Key?) - Optional - The key for the widget.

### Usage
This constructor is used to create an item for a FBottomNavigationBar. It is a const constructor.
```

--------------------------------

### FTooltipController constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tooltip/FTooltipController-class.html

Creates an FTooltipController with the given vsync and initial shown state.

```APIDOC
## FTooltipController({required TickerProvider vsync, bool shown = false})

### Description
Creates an FTooltipController with the given `vsync` and `shown`.

### Parameters
- **vsync** (TickerProvider) - Required - The ticker provider for animations.
- **shown** (bool) - Optional - Initial visibility state, defaults to false.

### Returns
A new FTooltipController instance.
```

--------------------------------

### FLineCalendarScrollController Properties

Source: https://pub.dev/documentation/forui/latest/forui.widgets.line_calendar/FLineCalendarScrollController-class.html

Properties of the FLineCalendarScrollController class. The start property is the inclusive start date, and today is the current date. Both are DateTime in UTC and truncated to the nearest date.

```APIDOC
## FLineCalendarScrollController Properties

### Description
Properties of the FLineCalendarScrollController class.

### Properties

#### start
- **Type**: DateTime
- **Description**: The start date, inclusive. It is always in UTC and truncated to the nearest date. Defaults to `DateTime.utc(1900)`.

#### today
- **Type**: DateTime
- **Description**: The current date. It is always in UTC and truncated to the nearest date. Defaults to `DateTime.now`.

#### runtimeType
- **Type**: Type
- **Description**: A representation of the runtime type of the object. (inherited)
```

--------------------------------

### raw

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTileMixin-mixin.html

Creates an FTile without custom layout behavior. This static method allows full customization of the tile's appearance and behavior through various parameters.

```APIDOC
## raw

### Description
Creates a [FTile](https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTile-class.html) without custom layout behavior.

### Method
static

### Signature
```dart
raw({
  required Widget child,
  FItemVariant variant = .primary,
  FItemStyleDelta style = const .context(),
  bool? enabled,
  bool selected = false,
  String? semanticsLabel,
  String? semanticsTooltip,
  bool autofocus = false,
  FocusNode? focusNode,
  ValueChanged<bool>? onFocusChange,
  ValueChanged<bool>? onHoverChange,
  FTappableVariantChangeCallback? onVariantChange,
  VoidCallback? onPress,
  VoidCallback? onLongPress,
  VoidCallback? onDoubleTap,
  VoidCallback? onSecondaryPress,
  VoidCallback? onSecondaryLongPress,
  Map<ShortcutActivator, Intent>? shortcuts,
  Map<Type, Action<Intent>>? actions,
  Widget? prefix,
  Key? key
}) → FTile
```

### Parameters
- **child** (Widget) - Required - The widget to be displayed inside the tile.
- **variant** (FItemVariant) - Optional - The visual variant of the tile. Defaults to `.primary`.
- **style** (FItemStyleDelta) - Optional - Style overrides for the tile. Defaults to `const .context()`.
- **enabled** (bool?) - Optional - Whether the tile is enabled.
- **selected** (bool) - Optional - Whether the tile is selected. Defaults to `false`.
- **semanticsLabel** (String?) - Optional - Semantic label for accessibility.
- **semanticsTooltip** (String?) - Optional - Semantic tooltip for accessibility.
- **autofocus** (bool) - Optional - Whether the tile should autofocus. Defaults to `false`.
- **focusNode** (FocusNode?) - Optional - The focus node for the tile.
- **onFocusChange** (ValueChanged<bool>?) - Optional - Callback when focus changes.
- **onHoverChange** (ValueChanged<bool>?) - Optional - Callback when hover state changes.
- **onVariantChange** (FTappableVariantChangeCallback?) - Optional - Callback when the variant changes.
- **onPress** (VoidCallback?) - Optional - Callback when the tile is pressed.
- **onLongPress** (VoidCallback?) - Optional - Callback when the tile is long-pressed.
- **onDoubleTap** (VoidCallback?) - Optional - Callback when the tile is double-tapped.
- **onSecondaryPress** (VoidCallback?) - Optional - Callback for secondary press (e.g., right-click).
- **onSecondaryLongPress** (VoidCallback?) - Optional - Callback for secondary long press.
- **shortcuts** (Map<ShortcutActivator, Intent>?) - Optional - Keyboard shortcuts for the tile.
- **actions** (Map<Type, Action<Intent>>?) - Optional - Actions associated with the tile.
- **prefix** (Widget?) - Optional - A widget to display as a prefix.
- **key** (Key?) - Optional - The key for the widget.

### Returns
- **FTile** - The created tile widget.
```

--------------------------------

### FTabController.length

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tabs/FTabController-class.html

Gets the number of tabs.

```APIDOC
## FTabController.length

### Description
The number of tabs.

### Type
int

### Access
Getter only (no setter)
```

--------------------------------

### FCalendarDayVariantConstraint.start

Source: https://pub.dev/documentation/forui/latest/forui.widgets.calendar/FCalendarDayVariantConstraint-extension-type.html

The day is the start of a contiguous selection.

```APIDOC
## FCalendarDayVariantConstraint.start

### Description
The day is the start of a contiguous selection.

### Type
const FCalendarDayVariant

### Value
start
```

--------------------------------

### tile

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTileMixin-mixin.html

Creates an FTile widget with customizable title, style, callbacks, and optional prefix, subtitle, details, and suffix widgets.

```APIDOC
## tile

### Description
Creates an [FTile](https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTile-class.html) widget. This method allows customization of the tile's appearance, behavior, and content.

### Method
`FTile tile({required Widget title, FItemVariant variant = .primary, FItemStyleDelta style = const .context(), bool? enabled, bool selected = false, String? semanticsLabel, String? semanticsTooltip, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool>? onFocusChange, ValueChanged<bool>? onHoverChange, FTappableVariantChangeCallback? onVariantChange, VoidCallback? onPress, VoidCallback? onLongPress, VoidCallback? onDoubleTap, VoidCallback? onSecondaryPress, VoidCallback? onSecondaryLongPress, Map<ShortcutActivator, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, Widget? prefix, Widget? subtitle, Widget? details, Widget? suffix, Key? key})`

### Parameters
- **title** (Widget) - Required - The title widget of the tile.
- **variant** (FItemVariant) - Optional - The visual variant of the tile. Defaults to `.primary`.
- **style** (FItemStyleDelta) - Optional - Style adjustments for the tile. Defaults to `const .context()`.
- **enabled** (bool?) - Optional - Whether the tile is enabled.
- **selected** (bool) - Optional - Whether the tile is selected. Defaults to `false`.
- **semanticsLabel** (String?) - Optional - Semantic label for accessibility.
- **semanticsTooltip** (String?) - Optional - Semantic tooltip for accessibility.
- **autofocus** (bool) - Optional - Whether the tile should autofocus. Defaults to `false`.
- **focusNode** (FocusNode?) - Optional - Focus node for the tile.
- **onFocusChange** (ValueChanged<bool>?) - Optional - Callback when focus changes.
- **onHoverChange** (ValueChanged<bool>?) - Optional - Callback when hover state changes.
- **onVariantChange** (FTappableVariantChangeCallback?) - Optional - Callback when variant changes.
- **onPress** (VoidCallback?) - Optional - Callback when the tile is pressed.
- **onLongPress** (VoidCallback?) - Optional - Callback when the tile is long-pressed.
- **onDoubleTap** (VoidCallback?) - Optional - Callback when the tile is double-tapped.
- **onSecondaryPress** (VoidCallback?) - Optional - Callback for secondary press (e.g., right-click).
- **onSecondaryLongPress** (VoidCallback?) - Optional - Callback for secondary long press.
- **shortcuts** (Map<ShortcutActivator, Intent>?) - Optional - Keyboard shortcuts for the tile.
- **actions** (Map<Type, Action<Intent>>?) - Optional - Actions associated with the tile.
- **prefix** (Widget?) - Optional - Widget displayed before the title.
- **subtitle** (Widget?) - Optional - Widget displayed below the title.
- **details** (Widget?) - Optional - Widget displayed as details.
- **suffix** (Widget?) - Optional - Widget displayed after the title.
- **key** (Key?) - Optional - Key for the widget.

### Returns
- **FTile** - The created FTile widget.
```

--------------------------------

### FRawTileContentStyle constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FRawTileContentStyle-class.html

Creates a FRawTileContentStyle with specified prefix icon style, child text style, padding, and prefix icon spacing.

```APIDOC
## FRawTileContentStyle()

### Description
Creates a FRawTileContentStyle with the given properties.

### Constructor
FRawTileContentStyle({required FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta> prefixIconStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> childTextStyle, EdgeInsetsGeometry padding = const .symmetric(horizontal: 15, vertical: 14.5), double prefixIconSpacing = 10})

### Parameters
- **prefixIconStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta>) - Required - The style for the prefix icon.
- **childTextStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - The style for the child text.
- **padding** (EdgeInsetsGeometry) - Optional - The padding around the content. Defaults to const .symmetric(horizontal: 15, vertical: 14.5).
- **prefixIconSpacing** (double) - Optional - The spacing between the prefix icon and the text. Defaults to 10.

```

--------------------------------

### FSliderStyles.vertical

Source: https://pub.dev/documentation/forui/latest/forui.widgets.slider/FSliderStyles-extension-type.html

Gets the vertical slider style.

```APIDOC
## FSliderStyles.vertical

### Description
Gets the vertical slider style.

### Property
`vertical` → `FSliderStyle`

### Return Value
`FSliderStyle` - The vertical slider style.

```

--------------------------------

### FBottomNavigationBarItemStyle constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.bottom_navigation_bar/FBottomNavigationBarItemStyle-class.html

Creates a FBottomNavigationBarItemStyle instance with the given icon style, text style, tappable style, focused outline style, padding, and spacing.

```APIDOC
## FBottomNavigationBarItemStyle()

### Description
Creates a FBottomNavigationBarItemStyle with the specified properties.

### Constructor
FBottomNavigationBarItemStyle({
  required FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta> iconStyle,
  required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> textStyle,
  required FTappableStyle tappableStyle,
  required FFocusedOutlineStyle focusedOutlineStyle,
  EdgeInsetsGeometry padding = const .all(5),
  double spacing = 2
})

### Parameters
- **iconStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta>) - Required - The icon style variants.
- **textStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - The text style variants.
- **tappableStyle** (FTappableStyle) - Required - The tappable style.
- **focusedOutlineStyle** (FFocusedOutlineStyle) - Required - The focused outline style.
- **padding** (EdgeInsetsGeometry) - Optional - The padding, defaults to const .all(5).
- **spacing** (double) - Optional - The spacing, defaults to 2.

### Example
```dart
FBottomNavigationBarItemStyle(
  iconStyle: ...,
  textStyle: ...,
  tappableStyle: ...,
  focusedOutlineStyle: ...,
  padding: const EdgeInsets.all(5),
  spacing: 2,
)
```
```

--------------------------------

### FSliderStyles.horizontal

Source: https://pub.dev/documentation/forui/latest/forui.widgets.slider/FSliderStyles-extension-type.html

Gets the horizontal slider style.

```APIDOC
## FSliderStyles.horizontal

### Description
Gets the horizontal slider style.

### Property
`horizontal` → `FSliderStyle`

### Return Value
`FSliderStyle` - The horizontal slider style.

```

--------------------------------

### FRawTileContentStyle.inherit constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FRawTileContentStyle-class.html

Creates a FRawTileContentStyle that inherits its properties from the given colors, typography, prefix color, and color.

```APIDOC
## FRawTileContentStyle.inherit()

### Description
Creates a FRawTileContentStyle that inherits its properties from the provided theme components.

### Constructor
FRawTileContentStyle.inherit({required FColors colors, required FTypography typography, required Color prefix, required Color color})

### Parameters
- **colors** (FColors) - Required - The color scheme to inherit from.
- **typography** (FTypography) - Required - The typography to inherit from.
- **prefix** (Color) - Required - The color for the prefix icon.
- **color** (Color) - Required - The color for the text.

```

--------------------------------

### FTabController.index

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tabs/FTabController-class.html

Gets or sets the index of the selected tab.

```APIDOC
## FTabController.index

### Description
The index of the selected tab.

### Type
int

### Access
Getter/Setter pair
```

--------------------------------

### middle

Source: https://pub.dev/documentation/forui/latest/forui.widgets.calendar/FCalendarDayVariantConstraint-extension-type.html

The day is inside a contiguous selection, between a start and end.

```APIDOC
## middle

### Description
The day is inside a contiguous selection, between a start and end.

### Type
const FCalendarDayVariant

### Source
[middle-constant.html](https://pub.dev/documentation/forui/latest/forui.widgets.calendar/FCalendarDayVariantConstraint/middle-constant.html)
```

--------------------------------

### FTooltipStyle Constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tooltip/FTooltipStyle-class.html

Creates an FTooltipStyle instance with explicit configuration for decoration, text style, haptic feedback, and optional properties like background filter, padding, constraints, arrow style, motion, and durations.

```APIDOC
## FTooltipStyle Constructor

### Description
Creates an FTooltipStyle instance with explicit configuration for decoration, text style, haptic feedback, and optional properties like background filter, padding, constraints, arrow style, motion, and durations.

### Constructor
`FTooltipStyle({required Decoration decoration, required TextStyle textStyle, required Future<void> hapticFeedback(), ImageFilter? backgroundFilter, EdgeInsets padding = const .symmetric(horizontal: 12, vertical: 6), BoxConstraints constraints = const BoxConstraints(), FPortalArrowStyle arrowStyle = const FPortalArrowStyle(baseRadius: 0, width: 8, height: 5, tipRadius: 1.5), FTooltipMotion motion = const FTooltipMotion(), Duration hoverEnterDuration = const Duration(milliseconds: 500), Duration hoverExitDuration = const Duration(milliseconds: 100), Duration longPressExitDuration = const Duration(milliseconds: 1500)})`

### Parameters
- **decoration** (Decoration) - Required - The decoration for the tooltip.
- **textStyle** (TextStyle) - Required - The text style for the tooltip content.
- **hapticFeedback** (Future<void> Function()) - Required - A callback that provides haptic feedback.
- **backgroundFilter** (ImageFilter?) - Optional - An image filter applied to the background.
- **padding** (EdgeInsets) - Optional - Padding around the tooltip content. Defaults to `EdgeInsets.symmetric(horizontal: 12, vertical: 6)`.
- **constraints** (BoxConstraints) - Optional - Constraints for the tooltip size. Defaults to `BoxConstraints()`.
- **arrowStyle** (FPortalArrowStyle) - Optional - Style for the tooltip arrow. Defaults to `FPortalArrowStyle(baseRadius: 0, width: 8, height: 5, tipRadius: 1.5)`.
- **motion** (FTooltipMotion) - Optional - Motion configuration for the tooltip. Defaults to `FTooltipMotion()`.
- **hoverEnterDuration** (Duration) - Optional - Duration for hover enter animation. Defaults to `Duration(milliseconds: 500)`.
- **hoverExitDuration** (Duration) - Optional - Duration for hover exit animation. Defaults to `Duration(milliseconds: 100)`.
- **longPressExitDuration** (Duration) - Optional - Duration for long press exit animation. Defaults to `Duration(milliseconds: 1500)`.

### Remarks
This constructor is `const`.
```

--------------------------------

### FBottomNavigationBarItemStyle.inherit constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.bottom_navigation_bar/FBottomNavigationBarItemStyle-class.html

Creates a FBottomNavigationBarItemStyle that inherits its properties from the given colors, typography, and style.

```APIDOC
## FBottomNavigationBarItemStyle.inherit()

### Description
Creates a FBottomNavigationBarItemStyle that inherits its properties from the provided colors, typography, and style.

### Constructor
FBottomNavigationBarItemStyle.inherit({
  required FColors colors,
  required FTypography typography,
  required FStyle style
})

### Parameters
- **colors** (FColors) - Required - The colors to inherit.
- **typography** (FTypography) - Required - The typography to inherit.
- **style** (FStyle) - Required - The style to inherit.

### Example
```dart
FBottomNavigationBarItemStyle.inherit(
  colors: ...,
  typography: ...,
  style: ...,
)
```
```

--------------------------------

### pages property

Source: https://pub.dev/documentation/forui/latest/forui.widgets.pagination/FPaginationController-class.html

Gets or sets the total number of pages in the pagination.

```APIDOC
## pages ↔ int

### Description
Gets or sets the total number of pages.

### Type
int

### Access
Getter and setter pair.
```

--------------------------------

### FContextMenu.tiles

Source: https://pub.dev/documentation/forui/latest/forui.widgets.context_menu/FContextMenu-class.html

Creates a context menu of FTiles. This constructor accepts numerous parameters to configure the popover behavior, styling, and menu content.

```APIDOC
## FContextMenu.tiles

### Description
Creates a context menu of [FTile]s.

### Constructor
`FContextMenu.tiles({FPopoverControl control = const .managed(), FPopoverMenuStyleDelta style = const .context(), ScrollController? scrollController, ScrollCacheExtent? scrollCacheExtent, double maxHeight = .infinity, bool intrinsicWidth = true, DragStartBehavior dragStartBehavior = .start, FItemDivider divider = .full, AlignmentGeometry menuAnchor = .topLeft, double spacing = 0, FPortalOverflow overflow = .flip, bool useViewPadding = true, bool useViewInsets = true, OverlayChildLocation overlayLocation = .nearestOverlay, Offset offset = .zero, Object? groupId, FPopoverHideRegion hideRegion = .excludeChild, VoidCallback? onTapHide, String? barrierSemanticsLabel, bool barrierSemanticsDismissible = true, bool cutout = false, void cutoutBuilder(Path path, Rect bounds) = FModalBarrier.defaultCutoutBuilder, String? semanticsLabel, bool? autofocus, FocusScopeNode? focusNode, ValueChanged<bool>? onFocusChange, TraversalEdgeBehavior? traversalEdgeBehavior, bool? faded, bool? longPress, bool? secondaryPress, ValueWidgetBuilder<FPopoverController> builder = FPopover.defaultBuilder, Widget? child, List<FTileGroupMixin> menuBuilder(BuildContext context, FPopoverController controller, List<FTileGroupMixin>? menu) = FPopoverMenu.defaultTileBuilder, List<FTileGroupMixin>? menu, Key? key})`

### Parameters

#### Named Parameters
- **control** (FPopoverControl) - Default: `const .managed()` - Controls the popover behavior.
- **style** (FPopoverMenuStyleDelta) - Default: `const .context()` - Style delta for the popover menu.
- **scrollController** (ScrollController?) - Optional - Scroll controller for the menu.
- **scrollCacheExtent** (ScrollCacheExtent?) - Optional - Cache extent for scrolling.
- **maxHeight** (double) - Default: `.infinity` - Maximum height of the menu.
- **intrinsicWidth** (bool) - Default: `true` - Whether to use intrinsic width.
- **dragStartBehavior** (DragStartBehavior) - Default: `.start` - Drag start behavior.
- **divider** (FItemDivider) - Default: `.full` - Divider style for items.
- **menuAnchor** (AlignmentGeometry) - Default: `.topLeft` - Anchor alignment for the menu.
- **spacing** (double) - Default: `0` - Spacing between items.
- **overflow** (FPortalOverflow) - Default: `.flip` - Overflow behavior.
- **useViewPadding** (bool) - Default: `true` - Whether to use view padding.
- **useViewInsets** (bool) - Default: `true` - Whether to use view insets.
- **overlayLocation** (OverlayChildLocation) - Default: `.nearestOverlay` - Overlay child location.
- **offset** (Offset) - Default: `.zero` - Offset of the menu.
- **groupId** (Object?) - Optional - Group ID for the popover.
- **hideRegion** (FPopoverHideRegion) - Default: `.excludeChild` - Hide region behavior.
- **onTapHide** (VoidCallback?) - Optional - Callback when tapped to hide.
- **barrierSemanticsLabel** (String?) - Optional - Semantics label for the barrier.
- **barrierSemanticsDismissible** (bool) - Default: `true` - Whether barrier is dismissible via semantics.
- **cutout** (bool) - Default: `false` - Whether to use a cutout.
- **cutoutBuilder** (void Function(Path, Rect)) - Default: `FModalBarrier.defaultCutoutBuilder` - Builds the cutout path.
- **semanticsLabel** (String?) - Optional - Semantics label for the menu.
- **autofocus** (bool?) - Optional - Whether to autofocus.
- **focusNode** (FocusScopeNode?) - Optional - Focus node.
- **onFocusChange** (ValueChanged<bool>?) - Optional - Callback when focus changes.
- **traversalEdgeBehavior** (TraversalEdgeBehavior?) - Optional - Traversal edge behavior.
- **faded** (bool?) - Optional - Whether the menu is faded.
- **longPress** (bool?) - Optional - Whether long press is enabled.
- **secondaryPress** (bool?) - Optional - Whether secondary press is enabled.
- **builder** (ValueWidgetBuilder<FPopoverController>) - Default: `FPopover.defaultBuilder` - Builder for the popover.
- **child** (Widget?) - Optional - The child widget.
- **menuBuilder** (List<FTileGroupMixin> Function(BuildContext, FPopoverController, List<FTileGroupMixin>?)) - Default: `FPopoverMenu.defaultTileBuilder` - Builds the menu items.
- **menu** (List<FTileGroupMixin>?) - Optional - The menu items.
- **key** (Key?) - Optional - The widget key.

### Usage Example
```dart
FContextMenu.tiles(
  menu: [
    // FTileGroupMixin items
  ],
  child: // your widget
)
```
```

--------------------------------

### Decorations.image

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the DecorationImage, or null if the decoration doesn't define one.

```APIDOC
## image

### Description
Gets the DecorationImage, or null if the decoration doesn't define one.

### Declaration
`DecorationImage? get image`

### Return Value
- **DecorationImage?** - The decoration image, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### Decorations.gradient

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the Gradient, or null if the decoration doesn't define one.

```APIDOC
## gradient

### Description
Gets the Gradient, or null if the decoration doesn't define one.

### Declaration
`Gradient? get gradient`

### Return Value
- **Gradient?** - The gradient, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### FRawItemContentStyle constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.item/FRawItemContentStyle-class.html

Creates a FRawItemContentStyle instance with the given prefix icon style, child text style, padding, and optional prefix icon spacing.

```APIDOC
## FRawItemContentStyle

### Description
Creates a FRawItemContentStyle instance.

### Constructor
`FRawItemContentStyle({required FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta> prefixIconStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> childTextStyle, required EdgeInsetsGeometry padding, double prefixIconSpacing = 8})`

### Parameters
- **prefixIconStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta>) - Required - The style for the prefix icon.
- **childTextStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - The style for the child text.
- **padding** (EdgeInsetsGeometry) - Required - The padding around the content.
- **prefixIconSpacing** (double) - Optional - The spacing between the prefix icon and the content. Defaults to 8.

### Example
```dart
FRawItemContentStyle(
  prefixIconStyle: ...,
  childTextStyle: ...,
  padding: EdgeInsets.all(8),
  prefixIconSpacing: 8,
)
```
```

--------------------------------

### Decorations.borderRadius

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the BorderRadiusGeometry, or null if the decoration doesn't define one.

```APIDOC
## borderRadius

### Description
Gets the BorderRadiusGeometry, or null if the decoration doesn't define one.

### Declaration
`BorderRadiusGeometry? get borderRadius`

### Return Value
- **BorderRadiusGeometry?** - The border radius, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### FTooltipStyle.inherit Constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tooltip/FTooltipStyle-class.html

Creates an FTooltipStyle that inherits properties from the given theme colors, typography, style, and haptic feedback, with optional overrides for motion and durations.

```APIDOC
## FTooltipStyle.inherit Constructor

### Description
Creates an FTooltipStyle that inherits properties from the given theme colors, typography, style, and haptic feedback, with optional overrides for motion and durations.

### Constructor
`FTooltipStyle.inherit({required FColors colors, required FTypography typography, required FStyle style, required FHapticFeedback hapticFeedback, FTooltipMotion motion = const FTooltipMotion(), Duration hoverEnterDuration = const Duration(milliseconds: 500), Duration hoverExitDuration = const Duration(milliseconds: 100), Duration longPressExitDuration = const Duration(milliseconds: 1500)})`

### Parameters
- **colors** (FColors) - Required - The color scheme to inherit.
- **typography** (FTypography) - Required - The typography to inherit.
- **style** (FStyle) - Required - The style to inherit.
- **hapticFeedback** (FHapticFeedback) - Required - The haptic feedback configuration to inherit.
- **motion** (FTooltipMotion) - Optional - Motion configuration. Defaults to `FTooltipMotion()`.
- **hoverEnterDuration** (Duration) - Optional - Duration for hover enter animation. Defaults to `Duration(milliseconds: 500)`.
- **hoverExitDuration** (Duration) - Optional - Duration for hover exit animation. Defaults to `Duration(milliseconds: 100)`.
- **longPressExitDuration** (Duration) - Optional - Duration for long press exit animation. Defaults to `Duration(milliseconds: 1500)`.

### Remarks
This constructor is `const`.
```

--------------------------------

### FCard

Source: https://pub.dev/documentation/forui/latest/forui.widgets.card/

A card widget. See the provided link for working examples.

```APIDOC
## FCard

### Description
A card widget.

### Class
FCard

### Reference
[https://pub.dev/documentation/forui/latest/forui.widgets.card/FCard-class.html](https://pub.dev/documentation/forui/latest/forui.widgets.card/FCard-class.html)

### Examples
See [https://forui.dev/docs/widgets/data/card](https://forui.dev/docs/widgets/data/card) for working examples.
```

--------------------------------

### FBottomNavigationBarStyle constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.bottom_navigation_bar/FBottomNavigationBarStyle-class.html

Creates a FBottomNavigationBarStyle with explicit decoration, itemStyle, and optional parameters.

```APIDOC
## FBottomNavigationBarStyle()

### Description
Creates a FBottomNavigationBarStyle with the given decoration, itemStyle, and optional parameters.

### Constructor
FBottomNavigationBarStyle({
  required Decoration decoration,
  required FBottomNavigationBarItemStyle itemStyle,
  ImageFilter? backgroundFilter,
  EdgeInsetsGeometry padding = const .all(5),
  FVariants<FPlatformVariantConstraint, FPlatformVariant, bool, Delta> slideableItems = const .all(true)
})

### Parameters
- **decoration** (Decoration) - Required - The decoration for the bottom navigation bar.
- **itemStyle** (FBottomNavigationBarItemStyle) - Required - The style for the items.
- **backgroundFilter** (ImageFilter?) - Optional - Background filter for the bar.
- **padding** (EdgeInsetsGeometry) - Optional - Padding around the bar, defaults to EdgeInsets.all(5).
- **slideableItems** (FVariants<FPlatformVariantConstraint, FPlatformVariant, bool, Delta>) - Optional - Variants for slideable items, defaults to all(true).

### Example
```dart
FBottomNavigationBarStyle(
  decoration: myDecoration,
  itemStyle: myItemStyle,
)
```
```

--------------------------------

### FTile constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTile-class.html

Creates an FTile widget with the given parameters. The title is required, and all other parameters are optional with defaults.

```APIDOC
## FTile Constructor

### Description
Creates an [FTile](https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTile-class.html) widget.

### Constructor
`FTile({required Widget title, FItemVariant variant = .primary, FItemStyleDelta style = const .context(), bool? enabled, bool selected = false, String? semanticsLabel, String? semanticsTooltip, bool? semanticsExpanded, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool>? onFocusChange, ValueChanged<bool>? onHoverChange, FTappableVariantChangeCallback? onVariantChange, VoidCallback? onPress, VoidCallback? onLongPress, VoidCallback? onDoubleTap, VoidCallback? onSecondaryPress, VoidCallback? onSecondaryLongPress, Map<ShortcutActivator, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, Widget? prefix, Widget? subtitle, Widget? details, Widget? suffix, Key? key})`

### Parameters
- **title** (Widget) - Required - The title widget to display.
- **variant** (FItemVariant) - Optional - Defaults to `.primary`. The visual variant of the tile.
- **style** (FItemStyleDelta) - Optional - Defaults to `const .context()`. Style delta for the tile.
- **enabled** (bool?) - Optional - Whether the tile is enabled.
- **selected** (bool) - Optional - Defaults to `false`. Whether the tile is selected.
- **semanticsLabel** (String?) - Optional - Semantic label for accessibility.
- **semanticsTooltip** (String?) - Optional - Semantic tooltip for accessibility.
- **semanticsExpanded** (bool?) - Optional - Semantic expanded state for accessibility.
- **autofocus** (bool) - Optional - Defaults to `false`. Whether the tile should autofocus.
- **focusNode** (FocusNode?) - Optional - Focus node for the tile.
- **onFocusChange** (ValueChanged<bool>?) - Optional - Callback when focus changes.
- **onHoverChange** (ValueChanged<bool>?) - Optional - Callback when hover changes.
- **onVariantChange** (FTappableVariantChangeCallback?) - Optional - Callback when variant changes.
- **onPress** (VoidCallback?) - Optional - Callback when the tile is pressed.
- **onLongPress** (VoidCallback?) - Optional - Callback when the tile is long-pressed.
- **onDoubleTap** (VoidCallback?) - Optional - Callback when the tile is double-tapped.
- **onSecondaryPress** (VoidCallback?) - Optional - Callback when the tile is secondary-pressed.
- **onSecondaryLongPress** (VoidCallback?) - Optional - Callback when the tile is secondary-long-pressed.
- **shortcuts** (Map<ShortcutActivator, Intent>?) - Optional - Keyboard shortcuts for the tile.
- **actions** (Map<Type, Action<Intent>>?) - Optional - Actions for the tile.
- **prefix** (Widget?) - Optional - Widget to display before the title.
- **subtitle** (Widget?) - Optional - Widget to display below the title.
- **details** (Widget?) - Optional - Widget to display as details.
- **suffix** (Widget?) - Optional - Widget to display after the title.
- **key** (Key?) - Optional - Key for the widget.

### Returns
An [FTile](https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTile-class.html) widget instance.
```

--------------------------------

### FPickerController.wheels property

Source: https://pub.dev/documentation/forui/latest/forui.widgets.picker/FPickerController-class.html

Gets the list of FixedExtentScrollController instances for the individual picker wheels.

```APIDOC
## List<FixedExtentScrollController> wheels

### Description
The controllers for the individual picker wheels. This is a final property, so it cannot be set.

### Getter
Returns the list of scroll controllers for each wheel.

### Example
```dart
List<FixedExtentScrollController> wheelControllers = controller.wheels;
```
```

--------------------------------

### FTooltipMotion constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tooltip/FTooltipMotion-class.html

Creates a FTooltipMotion instance with configurable durations, curves, and tweens for tooltip animations.

```APIDOC
## FTooltipMotion constructor

### Description
Creates a FTooltipMotion instance with configurable durations, curves, and tweens for tooltip animations.

### Constructor
`FTooltipMotion({Duration entranceDuration = const Duration(milliseconds: 100), Duration exitDuration = const Duration(milliseconds: 100), Curve expandCurve = Curves.easeOutCubic, Curve collapseCurve = Curves.easeOutCubic, Curve fadeInCurve = Curves.linear, Curve fadeOutCurve = Curves.linear, Animatable<double> scaleTween = const FImmutableTween(begin: 0.93, end: 1), Animatable<double> fadeTween = const FImmutableTween(begin: 0, end: 1)})`

### Parameters
- **entranceDuration** (Duration) - Optional - Duration of the entrance animation. Defaults to 100 milliseconds.
- **exitDuration** (Duration) - Optional - Duration of the exit animation. Defaults to 100 milliseconds.
- **expandCurve** (Curve) - Optional - Curve for the expand animation. Defaults to Curves.easeOutCubic.
- **collapseCurve** (Curve) - Optional - Curve for the collapse animation. Defaults to Curves.easeOutCubic.
- **fadeInCurve** (Curve) - Optional - Curve for the fade-in animation. Defaults to Curves.linear.
- **fadeOutCurve** (Curve) - Optional - Curve for the fade-out animation. Defaults to Curves.linear.
- **scaleTween** (Animatable<double>) - Optional - Tween for the scale animation. Defaults to FImmutableTween(begin: 0.93, end: 1).
- **fadeTween** (Animatable<double>) - Optional - Tween for the fade animation. Defaults to FImmutableTween(begin: 0, end: 1).

### Notes
- The constructor is const.
- When FAccessibility.motion is FAccessibilityMotion.reduced, only the fade transition is applied.
- When FAccessibility.motion is FAccessibilityMotion.disabled, no motion is applied.
```

--------------------------------

### Decorations.shadows

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the list of shadows, or null if the decoration doesn't define one.

```APIDOC
## shadows

### Description
Gets the list of shadows, or null if the decoration doesn't define one.

### Declaration
`List<BoxShadow>? get shadows`

### Return Value
- **List<BoxShadow>?** - The list of shadows, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### Decorations.color

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the background color, or null if the decoration doesn't define one.

```APIDOC
## color

### Description
Gets the background color, or null if the decoration doesn't define one.

### Declaration
`Color? get color`

### Return Value
- **Color?** - The background color, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### FTileContentStyle constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTileContentStyle-class.html

Creates a FTileContentStyle instance with the given style properties for prefix icon, title, subtitle, details, and suffix icon.

```APIDOC
## FTileContentStyle({required FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta> prefixIconStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> titleTextStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> subtitleTextStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta> detailsTextStyle, required FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta> suffixIconStyle, EdgeInsetsGeometry suffixedPadding = const .fromSTEB(15, 14.5, 13, 14.5), EdgeInsetsGeometry unsuffixedPadding = const .symmetric(horizontal: 15, vertical: 14.5), double prefixIconSpacing = 10, double titleSpacing = 3, double middleSpacing = 4, double suffixIconSpacing = 5})

### Description
Creates a [FTileContentStyle] instance with the specified style properties.

### Parameters
- **prefixIconStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta>) - Required - Style for the prefix icon.
- **titleTextStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - Style for the title text.
- **subtitleTextStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - Style for the subtitle text.
- **detailsTextStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, TextStyle, TextStyleDelta>) - Required - Style for the details text.
- **suffixIconStyle** (FVariants<FTappableVariantConstraint, FTappableVariant, IconThemeData, IconThemeDataDelta>) - Required - Style for the suffix icon.
- **suffixedPadding** (EdgeInsetsGeometry) - Optional - Padding when a suffix icon is present. Defaults to `const .fromSTEB(15, 14.5, 13, 14.5)`.
- **unsuffixedPadding** (EdgeInsetsGeometry) - Optional - Padding when no suffix icon is present. Defaults to `const .symmetric(horizontal: 15, vertical: 14.5)`.
- **prefixIconSpacing** (double) - Optional - Spacing before the prefix icon. Defaults to `10`.
- **titleSpacing** (double) - Optional - Spacing around the title. Defaults to `3`.
- **middleSpacing** (double) - Optional - Spacing between middle elements. Defaults to `4`.
- **suffixIconSpacing** (double) - Optional - Spacing before the suffix icon. Defaults to `5`.

### Returns
A new [FTileContentStyle] instance.
```

--------------------------------

### Decorations.border

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the shape border, or null if one can't be derived.

```APIDOC
## border

### Description
Gets the shape border, or null if one can't be derived.

### Declaration
`ShapeBorder? get border`

### Return Value
- **ShapeBorder?** - The shape border, or null if not derivable.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### FTileStyle.inherit constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.tile/FTileStyle-class.html

Creates a FTileStyle by inheriting from a base FStyle.

```APIDOC
## FTileStyle.inherit({required FColors colors, required FTypography typography, required FStyle style})

### Description
Creates a [FTileStyle] by inheriting from the given [FStyle].

### Parameters
- **colors** (FColors) - Required - The colors to use.
- **typography** (FTypography) - Required - The typography to use.
- **style** (FStyle) - Required - The base style to inherit from.

### Returns
A new [FTileStyle] instance.
```

--------------------------------

### Decorations.backgroundBlendMode

Source: https://pub.dev/documentation/forui/latest/forui.theme/Decorations.html

Gets the BlendMode applied to the color or gradient background, or null if not defined.

```APIDOC
## backgroundBlendMode

### Description
Gets the BlendMode applied to the color or gradient background, or null if the decoration doesn't define one.

### Declaration
`BlendMode? get backgroundBlendMode`

### Return Value
- **BlendMode?** - The blend mode, or null if not defined.

### Remarks
Available on Decoration, provided by the Decorations extension. Only BoxDecoration and ShapeDecoration are supported; other decorations return null.
```

--------------------------------

### FMultiSelectFieldSizeStyles constructor

Source: https://pub.dev/documentation/forui/latest/forui.widgets.select/FMultiSelectFieldSizeStyles-extension-type.html

Creates a FMultiSelectFieldSizeStyles instance. This is the default constructor.

```APIDOC
## FMultiSelectFieldSizeStyles()

### Description
Creates a FMultiSelectFieldSizeStyles instance.

### Constructor
FMultiSelectFieldSizeStyles(FVariants<FTextFieldSizeVariantConstraint, FTextFieldSizeVariant, FMultiSelectFieldStyle, FMultiSelectFieldStyleDelta> _)

### Parameters
- **_** (FVariants<FTextFieldSizeVariantConstraint, FTextFieldSizeVariant, FMultiSelectFieldStyle, FMultiSelectFieldStyleDelta>) - Required - The variants for the size styles.
```

--------------------------------

### FPickerController.value property

Source: https://pub.dev/documentation/forui/latest/forui.widgets.picker/FPickerController-class.html

Gets or sets the current value (list of indexes) stored in the controller.

```APIDOC
## List<int> value

### Description
The current value stored in this notifier. The value contains the index of the selected item in each wheel. The indexes are ordered from left to right if the current text direction is LTR, and from right to left if RTL.

### Getter
Returns the current list of indexes.

### Setter
Sets the current list of indexes and notifies listeners.

### Example
```dart
List<int> currentIndexes = controller.value;
controller.value = [1, 2, 3];
```
```

--------------------------------

### FOverlay Constructor

Source: https://pub.dev/documentation/forui/latest/forui.foundation/FOverlay-class.html

Creates a low-level overlay with the given parameters. The overlay parameter is required, and other parameters have defaults.

```APIDOC
## FOverlay Constructor

### Description
Creates a low-level overlay widget.

### Constructor
`FOverlay({required List<Widget> overlay, FOverlayControl control = const .managed(), FOverlayBuilder overlayBuilder = defaultOverlayBuilder, OverlayChildLocation overlayLocation = .nearestOverlay, ValueWidgetBuilder<OverlayPortalController> builder = defaultBuilder, Widget? child, Key? key})`

### Parameters
- **overlay** (List<Widget>) - Required - The widgets to overlay on the child.
- **control** (FOverlayControl) - Optional - The control for showing/hiding the overlay. Defaults to `const .managed()`.
- **overlayBuilder** (FOverlayBuilder) - Optional - A builder that transforms overlay widgets before they are displayed. Defaults to `defaultOverlayBuilder`.
- **overlayLocation** (OverlayChildLocation) - Optional - The Overlay that the portal is attached to. Defaults to `.nearestOverlay`.
- **builder** (ValueWidgetBuilder<OverlayPortalController>) - Optional - An optional builder for the child widget. Defaults to `defaultBuilder`.
- **child** (Widget?) - Optional - The child widget that the overlay is relative to.
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.

### Usage
This constructor is used to create an FOverlay widget instance.
```
Tokens:
Raw