This update overhauls the API by introducing controls to support declarative state and adding support for the new dot-shorthand syntax.

To simplify updating to the latest version, we've included Data Driven Fixes. This allows you to run automated fixes on your codebase to update it to be compatible with the latest version of forui.

After updating to the latest version, run:

dart fix --apply

FAccordion

• Add FAccordionControl.

• Breaking Remove FAccordion.controller. Use FAccordion(control: .managed(...)) instead.

• Fix FAccordionItem not being properly disposed.

FAutocomplete

• Add FAutocomplete.popoverControl.

• Add FAutocompleteControl.

• Add FAutocompleteItemMixin.item(...).

• Add FAutocompleteItemMixin.raw(...).

• Add FAutocompleteItemMixin.section(...).

• Add FAutocompleteItemMixin.richSection(...).

• Add FAutocompleteItem.item(...).

• Add FAutocomplete.contentGroupId.

• Breaking Rename FAutocomplete.anchor to FAutocomplete.contentAnchor.

• Breaking Rename FAutocomplete.popoverConstraints to FAutocomplete.contentConstraints.

• Breaking Rename FAutocomplete.spacing to FAutocomplete.contentSpacing.

• Breaking Rename FAutocomplete.shift to FAutocomplete.contentOverflow.

• Breaking Rename FAutocomplete.offset to FAutocomplete.contentOffset.

• Breaking Rename FAutocomplete.hideRegion to FAutocomplete.contentHideRegion.

• Breaking Rename FAutocomplete.onTapHide to FAutocomplete.contentOnTapHide.

• Breaking Remove FAutocomplete.controller. Use FAutocomplete(control: .managed(...)) instead.

• Breaking Remove FAutocomplete.initialText. Use FAutocomplete(control: .managed(...)) instead.

• Breaking Remove FAutocompleteController.vsync. Use FAutocomplete(popoverControl: ...) instead.

• Breaking Remove FAutocompleteController.popoverMotion. Use FAutocomplete(popoverControl: .managed(motion: ...)) instead.

• Breaking Remove FAutocompleteController.content. Use instead.

FBottomNavigationBar

• Add FBottomNavigationBar.safeAreaTop.

• Add FBottomNavigationBar.safeAreaBottom.

• Change FBottomNavigationBarItem.label to be optional.

FBreadcrumb

• Breaking Rename FBreadcrumb.shift to FBreadcrumb.overflow.
• Breaking Remove FBreadcrumbItem.collapsed(popoverController: ...). Use FBreadcrumbItem.collapsed(popoverControl: .managed(...)) instead.
• Breaking Remove FBreadcrumbItem.collapsedTiles(popoverController: ...). Use FBreadcrumbItem.collapsedTiles(popoverControl: .managed(...)) instead.

FCalendar

Unfortunately, FCalendar cannot be easily migrated using data driven fixes due to the complexity of its API changes.

• Add FCalendarControl.

• Breaking Rename FCalendarController.date(initialSelection: ...) to FCalendarController.date(initial: ...).

• Breaking Rename FCalendarController.dates(initialSelections: ...) to FCalendarController.dates(initial: ...).

• Breaking Rename FCalendarController.range(initialSelection: ...) to FCalendarController.range(initial: ...).

• Breaking Remove FCalendar.controller. Use FCalendar(control: .managedDate(...)) instead.

FCard

• Breaking Add FCard.mainAxisSize, which defaults to MainAxisSize.min.

FCheckbox

• Breaking Remove FCheckbox.grouped(...). Use FSelectGroupItemMixin.checkbox(...) instead.

FDateField

• Add FDateFieldControl.

• Add FDateField(popoverControl: ...).

• Add FDateField.calendar(popoverControl: ...).

• Add FDateField.calendar(groupId: ...).

• Add FDateFieldCalendarProperties.groupId.

• Change FDateField's input to preserve text selection when changing dates programmatically or via the calendar.

• Breaking Rename FDateField.shift to FDateField.overflow.

• Breaking Rename FDateFieldCalendarProperties.inputAnchor to FDateFieldCalendarProperties.fieldAnchor.

• Breaking Rename FDateField.calendar(inputAnchor: ...) to FDateField.calendar(fieldAnchor: ...).

• Breaking Rename FDateFieldController.calendar to FDateFieldController.popover.

• Breaking Rename FDateFieldController(initialDate: ...) to FDateFieldController(date: ...).

• Breaking Remove FDateField.controller. Use FDateField(control: .managed(controller: ...)) instead.

• Breaking Remove FDateField.initialDate. Use FDateField(control: .managed(initial: ...)) instead.

• Breaking Remove FDateField.onChange. Use FDateField(control: .managed(onChange: ...)) instead.

• Breaking Remove FDateFieldController(vsync: ..., popoverMotion: ...). Use FDateField(popoverControl: ...) instead.

• Breaking Remove FDateFieldController(truncateAndStripTimezone: ...).

FItem & FItemGroup

• Add FItemMixin.tile(...).
• Add FItemMixin.raw(...).
• Add FItemGroup.group(...).
• Add FItemGroupMixin.group(...).
• Add FItemGroupMixin.builder(...).
• Add FItemGroupMixin.merge(...).

FLineCalendar

• Add FLineCalendarControl.

• Breaking Remove FLineCalendar.controller. Use FLineCalendar(control: .managed(controller: ...)) instead.

• Breaking Remove FLineCalendar.initialSelection. Use FLineCalendar(control: .managed(initial: ...)) instead.

• Breaking Remove FLineCalendar.onChange. Use FLineCalendar(control: .managed(onChange: ...)) instead.

• Breaking Remove FLineCalendar.toggleable. Use FLineCalendar(control: .managed(toggleable: ...)) instead.

• Fix FLineCalendar not respecting FCalendarcontroller.selectable.

FPagination

• Add FPaginationControl.

• Breaking Remove FPagination.controller. Use FPagination(control: .managed(controller: ...)) instead.

• Breaking Remove FPagination.initialPage. Use FPagination(control: .managed(initialPage: ...)) instead.

• Breaking Remove FPagination.pages. Use FPagination(control: .managed(pages: ...)) instead.

• Breaking Remove FPagination.onChange. Use FPagination(control: .managed(onChange: ...)) instead.

• Breaking Change FPaginationController to extend ValueNotifier<int> instead of FChangeNotifier.

• Breaking Rename FPaginationController(initialPage: ...) to FPaginationController(page: ...).

• Breaking Rename FPaginationController.page to FPaginationController.value.

FPicker

• Add FPickerControl.

• Add FPickerController.animateTo(...).

• Breaking Rename FPickerController(initialIndexes: ...) to FPickerController(indexes: ...).

• Breaking Remove FPicker.controller. Use FPicker(control: .managed(...)) instead.

• Breaking Remove FPicker.onChange. Use FPicker(control: .managed(...)) instead.

FPopover

• Add FPopoverControl.

• Add FPopoverController.shown.

• Breaking Change FPopover.shift to FPopover.overflow.

• Breaking Remove FPopover.controller. Use FPopover(control: .managed(...)) instead.

• Fix FPopover not interrupting ongoing animations when toggled again.

FPopoverMenu

• Breaking Change FPopoverMenu.shift to FPopoverMenu.overflow.
• Breaking Remove FPopoverMenu.popoverController. Use FPopoverMenu(control: .managed(...)) instead.

FPortal

• Add FPortalSpacing.spacing(...).

• Breaking Rename FPortalBox to FPortalRect.

• Breaking Rename FPortalChildBox to FPortalChildRect.

• Breaking Rename FPortalShift to FPortalOverflow.

• Breaking Change FPortalShift from a function to a class. While this makes custom shift implementations slightly more verbose, it allows the consts to synergize with dot shorthands.

• Breaking Rename FPortalShift.along to FPortalShift.slide.

• Breaking Rename FPortal.shift to FPortal.overflow.

• Breaking Rename FPortalSpacing.resolve to FPortalSpacing.call.

FRadio

• Breaking Remove FRadio.grouped(...). Use FSelectGroupItemMixin.radio(...) instead.

FResizable

• Add FResizable.region(...).

• Add FResizableControl.

• Add FResizableManagedControl.

• Breaking Remove FResizable.controller. Use FResizable(control: .managed(...)) or FResizable(control: .managedCascade(...)) instead.

• Breaking Remove FResizable.onChange. Use FResizable(control: .managed(...)) instead.

FSelect & FMultiSelect

• Add FSelectControl.

• Add FSelectItemMixin.item(...).

• Add FSelectItemMixin.raw(...).

• Add FSelectItemMixin.section(...).

• Add FSelectItemMixin.richSection(...).

• Add FSelectItem.item(...).

• Add FSelect.contentGroupId.

• Add FMultiSelect.contentGroupId.

• Breaking Rename FSelect.anchor to FSelect.contentAnchor.

• Breaking Rename FSelect.popoverConstraints to FSelect.contentConstraints.

• Breaking Rename FSelect.spacing to FSelect.contentSpacing.

• Breaking Rename FSelect.shift to FSelect.contentOverflow.

• Breaking Rename FSelect.offset to FSelect.contentOffset.

• Breaking Rename FSelect.hideRegion to FSelect.contentHideRegion.

• Breaking Remove FSelect.controller. Use FSelect(control: .managed(...)) instead.

• Breaking Remove FSelect.onChange. Use FSelect(control: .managed(...)) instead.

• Breaking Remove FSelect.initialValue. Use FSelect(control: .managed(...)) instead.

• Breaking Remove FSelectController(vsync: ..., popoverMotion: ...). Use FSelect(popoverControl: ...) instead.

• Breaking Remove FSelectSearchFieldProperties.controller. Use FSelectSearchFieldProperties(control: .managed(...)) instead.

• Breaking Rename FMultiSelect.anchor to FMultiSelect.contentAnchor.

• Breaking Rename to .

FSelectGroup & FSelectTileGroup

• Add FSelectGroupItemMixin.checkbox(...).

• Add FSelectGroupItemMixin.radio(...).

• Breaking Remove FSelectGroup.controller. Use FSelectGroup(control: .managed(...)) instead.

• Breaking Remove FSelectGroup.onChange. Use FSelectGroup(control: .managed(...)) instead.

• Breaking Remove FSelectGroup.onSelect.

• Breaking Remove FSelectGroupController. Use FMultiValueNotifier instead.

• Breaking Rename FSelectGroupItem to FSelectGroupItemMixin.

FSelectMenuTile

• Add FSelectMenuTile.menuGroupId.

• Breaking Rename FSelectMenuTile.shift to FSelectMenuTile.menuOverflow.

• Breaking Rename FSelectMenuTile.spacing to FSelectMenuTile.menuSpacing.

• Breaking Rename FSelectMenuTile.offset to FSelectMenuTile.menuOffset.

• Breaking Rename FSelectMenuTile.hideRegion to FSelectMenuTile.menuHideRegion.

• Breaking Rename FSelectMenuTile.onTapHide to FSelectMenuTile.menuOnTapHide.

• Breaking Rename FSelectMenuTile.focusNode to FSelectMenuTile.menuFocusNode.

• Breaking Rename FSelectMenuTile.onFocusChange to FSelectMenuTile.menuOnFocusChange.

• Breaking Rename FSelectMenuTile.traversalEdgeBehavior to FSelectMenuTile.menuTraversalEdgeBehavior.

• Breaking Rename FSelectMenuTile.barrierSemanticsLabel to FSelectMenuTile.menuBarrierSemanticsLabel.

• Breaking Rename FSelectMenuTile.barrierSemanticsDismissible to FSelectMenuTile.menuBarrierSemanticsDismissible.

• Breaking Remove FSelectMenuTile.selectController. Use FSelectMenuTile(selectControl: .managed(...)) instead.

• Breaking Remove FSelectMenuTile.popoverController. Use FSelectMenuTile(popoverControl: .managed(...)) instead.

• Breaking Remove FSelectMenuTile.onChange. Use FSelectMenuTile(selectControl: .managed(...)) instead.

• Breaking Remove FSelectMenuTile.initialValue. Use FSelectMenuTile(selectControl: .managed(...)) instead.

• Breaking Remove FSelectMenuTile.onSelect.

FSelectTileGroup

• Breaking Remove FSelectTileGroupController. Use FMultiValueNotifier instead.
• Breaking Remove FSelectGroupController. Use FMultiValueNotifier instead.
• Breaking Remove FSelectTileGroup.selectController. Use FSelectTileGroup(control: .managed(...)) instead.
• Breaking Remove FSelectTileGroup.onChange. Use FSelectTileGroup(control: .managed(...)) instead.
• Breaking Remove FSelectTileGroup.onSelect.

FScaffold

• Breaking Remove FToaster from FScaffold. This was causing toasts to be cleared when switching between pages. Use FToaster directly instead.

FSheet

• Breaking Add showFSheet(resizeToAvoidBottomInset: ...). Set to false to restore previous behavior.
• Breaking Add showFPersistentSheet(resizeToAvoidBottomInset: ...). Set to false to restore previous behavior.
• Breaking Add FModalSheetRoute.resizeToAvoidBottomInset. Set to false to restore previous behavior.

FSlider

• Add FSlider.onEnd.

• Add FSliderMark.mark(...).

• Add FSliderControl.

• Add FSliderManagedControl.

• Breaking Rename FSliderSelection to FSliderValue.

• Breaking Remove FSliderController.tooltips. Use FSlider.tooltipControls. instead.

• Breaking Remove FSliderTooltipsController. Use FSliderTooltipControls instead.

• Breaking Remove FSlider.controller. Use FSlider(control: .managed(...)) instead.

• Breaking Remove FSlider.onChange. Use FSlider(control: .managed(...)) instead.

• Breaking Remove FSlider.initialSelection. Use FSlider(control: .managed(...)) instead.

FTabs

• Add FTabControl.

• Add FTabEntry.entry(...).

• Add FTabs.mouseCursor.

• Breaking Remove FTabs.controller. Use FTabs(control: .managed(...)) instead.

• Breaking Remove FTabs.initialIndex. Use FTabs(control: .managed(...)) instead.

• Breaking Remove FTabs.onChange. Use FTabs(control: .managed(...)) instead.

• Breaking Rename FTabController(initialIndex: ...) to FTabController(index: ...).

FTappable

• Change FTappable to only update focused state when it has primary focus.

FTextField

• Add FFieldClearIconBuilder.

• Add FObscureTextControl.

• Add FTextFieldControl.

• Add FTextField.control.

• Add FTextField.clearIconBuilder.

• Add FTextField.password.clearIconBuilder.

• Add FTextFormField.control.

• Breaking Remove FTextField.controller. Use FTextField(control: .managed(...)) instead.

• Breaking Remove FTextField.onChange. Use FTextField(control: .managed(...)) instead.

• Breaking Remove FTextField.initialText. Use FTextField(control: .managed(...)) instead.

• Breaking Remove FTextFormField.controller. Use FTextFormField(control: .managed(...)) instead.

• Breaking Remove FTextFormField.onChange. Use FTextFormField(control: .managed(...)) instead.

• Breaking Remove FTextFormField.initialText. Use FTextFormField(control: .managed(...)) instead.

• Breaking Remove FTextField.password(obscureTextController: ...). Use FTextField.password(obscureTextControl: ...) instead.

• Breaking Remove FTextFormField.password(obscureTextController: ...). Use FTextFormField.password(obscureTextControl: ...) instead.

FTile & FTileGroup

• Add FTileMixin.selectMenu(...).

• Add FTileMixin.selectMenuFromMap(...).

• Add FTileMixin.selectMenuBuilder(...).

• Add FTileMixin.tile(...).

• Add FTileMixin.raw(...).

• Add FTileGroupMixin.selectGroup(...).

• Add FTileGroupMixin.selectGroupBuilder(...).

• Add FTileGroupMixin.group(...).

• Add FTileGroupMixin.builder(...).

• Add FTileGroupMixin.merge(...).

• Breaking Remove FTileMixin.selectMenu(selectController: ...). Use FTileMixin.selectMenu(selectControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenu(popoverController: ...). Use FTileMixin.selectMenu(popoverControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenu(onChange: ...). Use FTileMixin.selectMenu(selectControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenu(onSelect: ...).

• Breaking Remove FTileMixin.selectMenu(initialValue: ...). Use FTileMixin.selectMenu(selectControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenuFromMap(selectController: ...). Use FTileMixin.selectMenuFromMap(selectControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenuFromMap(popoverController: ...). Use FTileMixin.selectMenuFromMap(popoverControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenuFromMap(onChange: ...). Use FTileMixin.selectMenuFromMap(selectControl: .managed(...)) instead.

• Breaking Remove FTileMixin.selectMenuFromMap(onSelect: ...).

• Breaking Remove FTileMixin.selectMenuFromMap(initialValue: ...). Use instead.

FTimeField

• Add FTimeFieldControl.

• Add FTimeField.picker(groupId: ...).

• Breaking Rename FTimeField.shift to FTimeField.overflow.

• Breaking Rename FTimeField.picker(inputAnchor: ...) to FTimeField.picker(fieldAnchor: ...).

• Breaking Move FTimeFieldStyle.popoverConstraints to FTimeField.picker(constraints: ...).

• Breaking Remove FTimeField.controller. Use FTimeField(control: .managed(...)) instead.

• Breaking Remove FTimeField.onChange. Use FTimeField(control: .managed(...)) instead.

• Breaking Remove FTimeField.initialTime. Use FTimeField(control: .managed(...)) instead.

• Breaking Remove FTimeFieldController(vsync: ..., popoverMotion: ...). Use FTimeField(popoverControl: ...) instead.

• Breaking Rename FTimeFieldController(initialTime: ...) to FTimeFieldController(time: ...).

FTimePicker

• Add FTimePickerControl.

• Breaking Remove FTimePicker.controller. Use FTimePicker(control: .managed(...)) instead.

• Breaking Remove FTimePicker.onChange. Use FTimePicker(control: .managed(...)) instead.

• Breaking Rename FTimePickerController(initial: ...) to FTimePickerController(time: ...).

• Fix FTimePickerController.animateTo(...) not working with period-first locales (e.g. Korean).

FTooltip

• Add FTooltipControl.

• Add FTooltipController.shown.

• Change FTooltip to not be focusable.

• Change FTooltip's focus-triggered behavior to only show if its immediate focusable descendant has primary focus.

• Breaking Rename FTooltip.shift to FTooltip.overflow.

• Breaking Remove FTooltip.controller. Use FTooltip(control: .managed(...)) instead.

• Fix FTooltip not interrupting ongoing animations when toggled again.

FToast

• Change FToasterMotion.collapseCurve's default value from easeOutCubic to easeOut.

Others

• Add FMultiValueControl.

• Add FTypeaheadController.fromValue(...).

• Add FTypeheadTextStyles.

• Breaking Remove FSidebar.width. This field was never intended for public usage - Use FSidebarStyle.constraints instead.

• Deprecate FValueNotifier. Please open an issue if there's a use-case that isn't covered.

• Deprecate FValueNotifier.addValueListener(...). Please open an issue if there's a use-case that isn't covered.

• Deprecate FValueNotifier.removeValueListener(...). Please open an issue if there's a use-case that isn't covered.

• Deprecate FMultiValueNotifier.addUpdateListener(...). Please open an issue if there's a use-case that isn't covered.

• Deprecate FMultiValueNotifier.removeUpdateListener(...). Please open an issue if there's a use-case that isn't covered.

• Fix generated style docs being malformed.