TabBar

Examples#

TabBar #

Bases: ConstrainedControl, 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
`AssertionError`	If `indicator` is None and `indicator_thickness` is not strictly greater than 0.
`AssertionError`	If `tab_alignment` is not valid for the given `scrollable` state.

adaptive #

adaptive: bool | None = None

Enables platform-specific rendering or inheritance of adaptiveness from parent controls.

animate_offset #

animate_offset: AnimationValue | None = None

Enables implicit animation of the offset property.

More information here.

animate_opacity #

animate_opacity: AnimationValue | None = None

Enables implicit animation of the opacity property.

More information here.

animate_position #

animate_position: AnimationValue | None = None

Enables implicit animation of the positioning properties (left, right, top and bottom).

More information here.

animate_rotation #

animate_rotation: AnimationValue | None = None

Enables implicit animation of the rotate property.

More information here.

animate_scale #

animate_scale: AnimationValue | None = None

Enables implicit animation of the scale property.

More information here.

animate_size #

animate_size: AnimationValue | None = None

TBD

aspect_ratio #

aspect_ratio: Number | None = None

TBD

badge #

badge: BadgeValue | None = None

A badge to show on top of this control.

bottom #

bottom: Number | None = None

The distance that the child's bottom edge is inset from the bottom of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

col #

col: ResponsiveNumber = 12

If a parent of this control is a ResponsiveRow, this property is used to determine how many virtual columns of a screen this control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}.

This control spans the 12 virtual columns by default.

Dimensions

Breakpoint	Dimension
xs	<576px
sm	≥576px
md	≥768px
lg	≥992px
xl	≥1200px
xxl	≥1400px

data #

data: Any = skip_field()

Arbitrary data of any type.

disabled #

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled.

Note

The value of this property will be propagated down to all children controls recursively.

Example

For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

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.

expand #

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose #

expand_loose: bool = False

Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.

More information here.

Note

If expand_loose is True, it will have effect only if:

expand is not None and
the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

height #

height: Number | None = None

Imposed Control height in virtual pixels.

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, [indicator_padding][flet.TabBar.indicator_padding], 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.

key #

key: KeyValue | None = 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.

left #

left: Number | None = None

The distance that the child's left edge is inset from the left of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

mouse_cursor #

mouse_cursor: MouseCursor | None = None

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

offset #

offset: OffsetValue | None = None

Applies a translation transformation before painting the control.

The translation is expressed as an Offset scaled to the control's size. So, Offset(x=0.25, y=0), for example, will result in a horizontal translation of one quarter the width of this control.

Example

The following example displays container at 0, 0 top left corner of a stack as transform applies -1 * 100, -1 * 100 (offset * control's size) horizontal and vertical translations to the control:

import flet as ft

def main(page: ft.Page):
    page.add(
        ft.Stack(
            width=1000,
            height=1000,
            controls=[
                ft.Container(
                    bgcolor="red",
                    width=100,
                    height=100,
                    left=100,
                    top=100,
                    offset=ft.Offset(-1, -1),
                )
            ],
        )
    )

ft.run(main)

on_animation_end #

on_animation_end: (
    ControlEventHandler[ConstrainedControl] | None
) = None

Called when animation completes.

Can be used to chain multiple animations.

The data property of the event handler argument contains the name of the animation.

More information here.

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.

opacity #

opacity: Number = 1.0

Defines the transparency of the control.

Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque without any transparency).

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.

page #

page: Page | BasePage | None

The page to which this control belongs to.

parent #

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

right #

right: Number | None = None

The distance that the child's right edge is inset from the right of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

rotate #

rotate: RotateValue | None = None

Transforms this control using a rotation around its center.

The value of rotate property could be one of the following types:

number - a rotation in clockwise radians. Full circle 360° is math.pi * 2 radians, 90° is pi / 2, 45° is pi / 4, etc.
Rotate - allows to specify rotation angle as well as alignment - the location of rotation center.

Example

For example:

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT)
)

rtl #

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

scale #

scale: ScaleValue | None = None

Scales this control along the 2D plane. Default scale factor is 1.0, meaning no-scale.

Setting this property to 0.5, for example, makes this control twice smaller, while 2.0 makes it twice larger.

Different scale multipliers can be specified for x and y axis, by setting Control.scale property to an instance of Scale class. Either scale or scale_x and scale_y could be specified, but not all of them.

Example

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    scale=ft.Scale(scale_x=2, scale_y=0.5)
)

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.

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

top #

top: Number | None = None

The distance that the child's top edge is inset from the top of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

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.

visible #

visible: bool = True

Every control has visible property which is True by default - control is rendered on the page. Setting visible to False completely prevents control (and all its children if any) from rendering on a page canvas. Hidden controls cannot be focused or selected with a keyboard or mouse and they do not emit any events.

width #

width: Number | None = None

Imposed Control width in virtual pixels.

before_event #

before_event(e: ControlEvent)

before_update #

before_update()

build #

build()

Called once during control initialization to define its child controls. self.page is available in this method.

clean #

clean() -> None

did_mount #

did_mount()

init #

init()

is_isolated #

is_isolated()

update #

update() -> None

will_unmount #

will_unmount()