CNTabBar class

A Cupertino-native tab bar. Uses native UITabBar/NSTabView style visuals.

On iOS 26+, supports a dedicated search tab that follows Apple's native behavior: appearing as a floating circular button that expands into a full search bar when tapped.

Example with search:

CNTabBar(
  items: [
    CNTabBarItem(label: 'Home', icon: CNIcon.symbol('house.fill')),
    CNTabBarItem(label: 'Profile', icon: CNIcon.symbol('person.fill')),
  ],
  currentIndex: _index,
  onTap: (i) => setState(() => _index = i),
  searchItem: CNTabBarSearchItem(
    placeholder: 'Find customer',
    onSearchChanged: (query) => filterResults(query),
  ),
)
Inheritance
Available extensions

Constructors

CNTabBar({Key? key, required List<CNTabBarItem> items, required int currentIndex, required ValueChanged<int> onTap, Color? tint, Color? backgroundColor, double? iconSize, double? height, bool split = false, int rightCount = 1, bool shrinkCentered = true, double splitSpacing = 12.0, bool splitRightAsButton = false, CNTabBarSearchItem? searchItem, CNTabBarSearchController? searchController, TextStyle? labelStyle, TextStyle? activeLabelStyle})
Creates a Cupertino-native tab bar.
const

Properties

activeLabelStyle → TextStyle?
Text style for the selected tab item label.
final
backgroundColor → Color?
Background color for the bar.
final
currentIndex → int
The index of the currently selected item.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
Fixed height; if null uses intrinsic height reported by native view.
final
iconSize → double?
Default icon size when item icon does not specify one.
final
items → List<CNTabBarItem>
Items to display in the tab bar.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
labelStyle → TextStyle?
Text style for unselected tab item labels.
final
onTap → ValueChanged<int>
Called when the user selects a new item.
final
rightCount → int
How many trailing items to pin right when split is true.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchController → CNTabBarSearchController?
Optional controller for programmatic search management.
final
searchItem → CNTabBarSearchItem?
Optional search tab configuration.
final
shrinkCentered → bool
When true, centers the split groups more tightly.
final
split → bool
When true, splits items between left and right sections.
final
splitRightAsButton → bool
When true and split is enabled, the right-side items act as plain buttons instead of selectable tabs. Tapping them fires onTap but does not change the visual selection — selection is controlled solely by currentIndex.
final
splitSpacing → double
Gap between left/right halves when split.
final
tint → Color?
Accent/tint color.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CNTabBar>
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
liquidGlass({CNGlassEffect effect = CNGlassEffect.regular, CNGlassEffectShape shape = CNGlassEffectShape.capsule, double? cornerRadius, Color? tint, bool interactive = false}) → Widget

Available on Widget, provided by the LiquidGlassExtension extension

Applies a Liquid Glass effect to this widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
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

Operators

operator ==(Object other) → bool
The equality operator.
inherited