TFormBuilder class

A responsive form builder with grid and tab layouts.

TFormBuilder provides automatic form layout with:

• 12-column responsive grid system
• Automatic field sizing based on breakpoints
• Integration with TFormBase
• Nested form support (accordion, horizontal tabs, vertical tabs)

Basic Usage

class UserForm extends TFormBase {
  final name = TFieldProp<String>('');
  final email = TFieldProp<String>('');

  @override
  List<TFormField> get fields => [
    TFormField.text(name, 'Name').size(6),
    TFormField.text(email, 'Email').size(6),
  ];
}

TFormBuilder(input: UserForm())

Tabbed Sub-forms Usage

TFormBuilder.horizontalTabs(
  tabs: [
    TFormTab(title: 'Account', icon: Icons.person, input: accountForm),
    TFormTab(title: 'Settings', icon: Icons.settings, input: settingsForm),
  ],
)

See also:

• TFormField for field creation
• TFormBase for form models
• TFormTab for tab configurations
• TTabs for tab navigation

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• TFormBuilder

Available extensions

• WidgetX

Constructors

TFormBuilder({Key? key, TFormBase? input, List<TFormField>? fields, List<TFormTab>? tabs, TFormType? formType, Axis tabAxis = Axis.horizontal, TTabController? tabController, dynamic initialTabValue, ValueChanged? onTabChanged, double? tabWidth, bool scrollableTabs = false, bool showTabNavigationButtons = true, bool tabInline = false, bool tabWrap = false, EdgeInsets? tabPadding, double tabSpacing = 2, double? tabIndicatorWidth, Color? tabSelectedColor, Color? tabUnselectedColor, Color? tabIndicatorColor, Color? tabBorderColor, Widget tabBuilder(BuildContext, TTab, bool, VoidCallback? )?, double gapX = 16.0, double gapY = 26.0, VoidCallback? onValueChanged, IconData? icon, String? label, String? description, bool initiallyExpanded = false, Widget? footer})

Creates a form builder.

const

TFormBuilder.horizontalTabs({Key? key, required List<TFormTab> tabs, TFormType? formType, TTabController? tabController, dynamic initialTabValue, ValueChanged? onTabChanged, bool scrollableTabs = false, bool showTabNavigationButtons = true, bool tabInline = false, bool tabWrap = false, EdgeInsets? tabPadding, double tabSpacing = 2, double? tabIndicatorWidth, Color? tabSelectedColor, Color? tabUnselectedColor, Color? tabIndicatorColor, Color? tabBorderColor, Widget tabBuilder(BuildContext, TTab, bool, VoidCallback? )?, double gapX = 16.0, double gapY = 26.0, VoidCallback? onValueChanged, IconData? icon, String? label, String? description, bool initiallyExpanded = false, Widget? footer})

Creates a form builder with horizontal tabs.

const

TFormBuilder.tabs({Key? key, required List<TFormTab> tabs, TFormType? formType, Axis tabAxis = Axis.horizontal, TTabController? tabController, dynamic initialTabValue, ValueChanged? onTabChanged, double? tabWidth, bool scrollableTabs = false, bool showTabNavigationButtons = true, bool tabInline = false, bool tabWrap = false, EdgeInsets? tabPadding, double tabSpacing = 2, double? tabIndicatorWidth, Color? tabSelectedColor, Color? tabUnselectedColor, Color? tabIndicatorColor, Color? tabBorderColor, Widget tabBuilder(BuildContext, TTab, bool, VoidCallback? )?, double gapX = 16.0, double gapY = 26.0, VoidCallback? onValueChanged, IconData? icon, String? label, String? description, bool initiallyExpanded = false, Widget? footer})

Creates a form builder with tabs.

const

TFormBuilder.verticalTabs({Key? key, required List<TFormTab> tabs, TFormType? formType, TTabController? tabController, dynamic initialTabValue, ValueChanged? onTabChanged, double? tabWidth, bool scrollableTabs = false, bool showTabNavigationButtons = true, EdgeInsets? tabPadding, double tabSpacing = 2, double? tabIndicatorWidth, Color? tabSelectedColor, Color? tabUnselectedColor, Color? tabIndicatorColor, Color? tabBorderColor, Widget tabBuilder(BuildContext, TTab, bool, VoidCallback? )?, double gapX = 16.0, double gapY = 26.0, VoidCallback? onValueChanged, IconData? icon, String? label, String? description, bool initiallyExpanded = false, Widget? footer})

Creates a form builder with vertical tabs.

const

Properties

description → String?

Optional subtitle for the form.

final

fields → List<TFormField>?

Manual list of fields (alternative to input or tabs).

final

footer → Widget?

Optional footer widget displayed below the form fields.

final

formType → TFormType?

Layout type for forms with sub forms (accordion, horizontal tabs, vertical tabs).

final

gapX → double

Horizontal spacing between fields.

final

gapY → double

Vertical spacing between fields.

final

hashCode → int

The hash code for this object.

no setter, inherited

icon → IconData?

final

initiallyExpanded → bool

final

initialTabValue → dynamic

Initial selected tab value when tabController is not provided.

final

input → TFormBase?

The form model to build.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

label → String?

Optional title for the form (renders inside an accordion when provided).

final

onTabChanged → ValueChanged?

Callback fired when the selected tab changes.

final

onValueChanged → VoidCallback?

Callback fired when any field value changes.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scrollableTabs → bool

Whether tabs should be scrollable.

final

showTabNavigationButtons → bool

Whether to show navigation arrows for scrollable tabs.

final

tabAxis → Axis

Layout axis for tabs (horizontal or vertical).

final

tabBorderColor → Color?

Border color for the tab bar.

final

tabBuilder → Widget Function(BuildContext, TTab, bool, VoidCallback? )?

Custom builder for tab items.

final

tabController → TTabController?

Optional controller for managing tab selection.

final

tabIndicatorColor → Color?

Color for the tab selection indicator.

final

tabIndicatorWidth → double?

Width/thickness of the tab selection indicator.

final

tabInline → bool

Whether tabs use inline mode instead of full width.

final

tabPadding → EdgeInsets?

Padding for each tab item.

final

tabs → List<TFormTab>?

List of tab configurations for sub forms.

final

tabSelectedColor → Color?

Color for the selected tab text/icon.

final

tabSpacing → double

Spacing between tab items.

final

tabUnselectedColor → Color?

Color for unselected tabs.

final

tabWidth → double?

Width of vertical tabs column.

final

tabWrap → bool

Whether tabs wrap onto multiple lines in inline mode.

final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.

center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<TFormBuilder>

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.

paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.

size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.

when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

operator ==(Object other) → bool

The equality operator.

inherited