TabBar

Examples#

TabBar #

Bases: LayoutControl, AdaptiveControl

Used for navigating frequently accessed, distinct content categories. Tabs allow for navigation between two or more content views and relies on text headers to articulate the different sections of content.

RAISES	DESCRIPTION
`ValueError`	If `indicator` is None and `indicator_thickness` is not strictly greater than 0.
`ValueError`	If `tab_alignment` is not valid for the given `scrollable` state.

divider_color #

divider_color: ColorValue | None = None

The color of the divider.

divider_height #

divider_height: Number | None = None

The height of the divider.

If None, defaults to TabBarTheme.divider_height. If this is also None, 1.0 will be used.

enable_feedback #

enable_feedback: bool | None = None

Whether detected gestures should provide acoustic and/or haptic feedback.

On Android, for example, setting this to True produce a click sound and a long-press will produce a short vibration.

Defaults to True.

indicator #

indicator: UnderlineTabIndicator | None = None

Defines the appearance of the selected tab indicator.

If this or TabBarTheme.indicator is not None, indicator_color and indicator_thickness properties are ignored.

The indicator's size is based on the tab's bounds. If indicator_size is TabBarIndicatorSize.TAB, the tab's bounds are as wide as the space occupied by the tab in the tab bar. If indicator_size is TabBarIndicatorSize.LABEL, then the tab's bounds are only as wide as the tab control itself.

indicator_animation #

indicator_animation: TabIndicatorAnimation | None = None

Specifies the animation behavior of the tab indicator.

If this is None, then the value of TabBarTheme.indicator_animation is used. If that is also None, then the tab indicator will animate linearly if the indicator_size is TabBarIndicatorSize.TAB, otherwise it will animate with an elastic effect if the indicator_size is TabBarIndicatorSize.LABEL.

indicator_color #

indicator_color: ColorValue | None = None

The color of the indicator(line that appears below the selected tab).

Note

Will be ignored if indicator or TabBarTheme.indicator is not None.

indicator_size #

indicator_size: TabBarIndicatorSize | None = None

Defines how the selected tab indicator's size is computed.

The size of the selected tab indicator is defined relative to the tab's overall bounds if indicator_size is TabBarIndicatorSize.TAB (the default) or relative to the bounds of the tab's control if indicator_size is TabBarIndicatorSize.LABEL.

The selected tab's location appearance can be refined further with the indicator_color, indicator_thickness, and indicator properties.

indicator_thickness #

indicator_thickness: Number = 2.0

The thickness of the indicator. Value must be greater than zero.

Note

Will be ignored if indicator or TabBarTheme.indicator is not None.

label_color #

label_color: ColorValue | None = None

The color of selected tab labels.

label_padding #

label_padding: PaddingValue | None = None

The padding around the tab label.

label_text_style #

label_text_style: TextStyle | None = None

The text style of the tab labels.

mouse_cursor #

mouse_cursor: MouseCursor | None = None

The cursor to be displayed when a mouse pointer enters or is hovering over this control.

on_click #

on_click: ControlEventHandler[TabBar] | None = None

Called when a tab is clicked.

The data property of the event handler argument contains the index of the clicked tab.

on_hover #

on_hover: EventHandler[TabBarHoverEvent] | None = None

Called when a tab's (from tabs) hover state in the tab bar changes.

When hover is moved from one tab directly to another, this will be called twice. First to represent hover exiting the initial tab, and then second for the pointer entering hover over the next tab.

overlay_color #

overlay_color: ControlStateValue[ColorValue] | None = None

Defines the ink response focus, hover, and splash colors in various ControlState states.

The following states are supported: ControlState.PRESSED, ControlState.HOVERED and ControlState.FOCUSED.

padding #

padding: PaddingValue | None = None

The padding around the Tabs control.

scrollable #

scrollable: bool = True

Whether this tab bar can be scrolled horizontally.

If True, then each tab is as wide as needed for its label and the entire tab bar is scrollable. Otherwise each tab gets an equal share of the available space.

secondary #

secondary: bool = False

Whether to create a secondary/nested tab bar.

Secondary tabs are used within a content area to further separate related content and establish hierarchy.

splash_border_radius #

splash_border_radius: BorderRadiusValue | None = None

Defines the clipping radius of splashes that extend outside the bounds of the tab.

tab_alignment #

tab_alignment: TabAlignment | None = None

Specifies the horizontal alignment of the tabs within this tab bar.

If this is None, then the value of TabBarTheme.tab_alignment is used. If TabBarTheme.tab_alignment is None and Theme.use_material3 is True, then TabAlignment.START_OFFSET is used if scrollable is True, otherwise TabAlignment.FILL is used.

If TabBarTheme.tab_alignment is None and Theme.use_material3 is False, then TabAlignment.CENTER is used if scrollable is True, otherwise TabAlignment.FILL is used.

Note

If scrollable is False, then tab_alignment must be either TabAlignment.FILL or TabAlignment.CENTER.
If scrollable is True, then tab_alignment must be TabAlignment.START, TabAlignment.START_OFFSET or TabAlignment.CENTER.

tabs #

tabs: list[Control]

A list of controls.

Typically Tabs.

unselected_label_color #

unselected_label_color: ColorValue | None = None

The color of unselected tab labels.

unselected_label_text_style #

unselected_label_text_style: TextStyle | None = None

The text style of the unselected tab labels.

before_update #

before_update()