Skip to main content

CupertinoSlidingSegmentedButton

A cupertino sliding segmented button.

Example:

ft.CupertinoSlidingSegmentedButton(
    selected_index=1,
    controls=[
        ft.Text("One"),
        ft.Text("Two"),
        ft.Text("Three"),
    ],
)
CupertinoSlidingSegmentedButton
Basic CupertinoSlidingSegmentedButton

Inherits: LayoutControl

Properties

Events

  • on_change - Called when the state of the button is changed - when one of the controls is clicked.

Examples​

Live example

Basic Example​

import flet as ft


def main(page: ft.Page):
    page.title = "CupertinoSlidingSegmentedButton Example"
    page.theme_mode = ft.ThemeMode.LIGHT

    def handle_selection_change(e: ft.Event[ft.CupertinoSlidingSegmentedButton]):
        page.show_dialog(
            ft.SnackBar(ft.Text(f"Segment {e.control.selected_index + 1} was chosen!"))
        )

    page.add(
        ft.SafeArea(
            content=ft.CupertinoSlidingSegmentedButton(
                selected_index=1,
                thumb_color=ft.Colors.BLUE_400,
                on_change=handle_selection_change,
                controls=[
                    ft.Text("One"),
                    ft.Text("Two"),
                    ft.Text("Three"),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)
basic

Properties​

bgcolorclass-attributeinstance-attribute​

bgcolor: ColorValue = CupertinoColors.TERTIARY_SYSTEM_FILL

The background color of this button.

controlsinstance-attribute​

controls: Annotated[list[Control], V.visible_controls(min_count=2)]

The list of segments to be displayed.

Raises:

  • ValueError - If it does not contain at least two visible Controls.

paddingclass-attributeinstance-attribute​

padding: PaddingValue = field(default_factory=(lambda: Padding.symmetric(vertical=2, horizontal=3)))

The amount of space by which to inset the controls.

proportional_widthclass-attributeinstance-attribute​

proportional_width: bool = False

Determine whether segments have proportional widths based on their content.

If False, all segments will have the same width, determined by the longest segment. If True, each segment's width will be determined by its individual content.

If the max width of parent constraints is smaller than the width that this control needs, the segment widths will scale down proportionally to ensure this control fits within the boundaries; similarly, if the min width of parent constraints is larger, the segment width will scales up to meet the min width requirement.

selected_indexclass-attributeinstance-attribute​

selected_index: int = 0

The index (starting from 0) of the selected segment in the controls list.

Raises:

  • IndexError - If it is not between 0 and the length of visible controls, inclusive.

thumb_colorclass-attributeinstance-attribute​

thumb_color: Optional[ColorValue] = None

The color of this button when it is not selected.

Events​

on_changeclass-attributeinstance-attribute​

on_change: Optional[ControlEventHandler[CupertinoSlidingSegmentedButton]] = None

Called when the state of the button is changed - when one of the controls is clicked.