SubmenuButton

Examples

Live example

Basic Example

import flet as ft


def main(page: ft.Page):
    page.padding = 0
    page.spacing = 0

    def handle_color_click(e: ft.Event[ft.MenuItemButton]):
        color = e.control.content.value
        background_container.content.value = f"{color} background color"
        background_container.bgcolor = color.lower()
        page.update()

    def handle_alignment_click(e: ft.Event[ft.MenuItemButton]):
        print(
            f"bg_container.alignment: {bg_container.alignment}, bg_container.content: {bg_container.content}"
        )
        background_container.alignment = e.control.data
        print(
            f"e.control.content.value: {e.control.content.value}, e.control.data: {e.control.data}"
        )
        page.update()

    def handle_on_hover(e: ft.Event[ft.MenuItemButton]):
        print(f"{e.control.content.value}.on_hover")

    bg_container = ft.Container(
        expand=True,
        bgcolor=ft.Colors.SURFACE_TINT,
        alignment=ft.Alignment.CENTER,
        content=ft.Text(
            value="Choose a bgcolor from the menu",
            style=ft.TextStyle(size=24, weight=ft.FontWeight.BOLD),
        ),
    )
    menubar = ft.MenuBar(
        expand=True,
        controls=[
            ft.SubmenuButton(
                content=ft.Text("Change Body"),
                controls=[
                    ft.SubmenuButton(
                        content=ft.Text("BG Color"),
                        leading=ft.Icon(ft.Icons.COLORIZE),
                        controls=[
                            ft.MenuItemButton(
                                content=ft.Text("Blue"),
                                on_click=handle_color_click,
                                on_hover=handle_on_hover,
                                style=ft.ButtonStyle(
                                    bgcolor={ft.ControlState.HOVERED: ft.Colors.BLUE}
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("Green"),
                                on_click=handle_color_click,
                                on_hover=handle_on_hover,
                                style=ft.ButtonStyle(
                                    bgcolor={ft.ControlState.HOVERED: ft.Colors.GREEN}
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("Red"),
                                on_click=handle_color_click,
                                on_hover=handle_on_hover,
                                style=ft.ButtonStyle(
                                    bgcolor={ft.ControlState.HOVERED: ft.Colors.RED}
                                ),
                            ),
                        ],
                    ),
                    ft.SubmenuButton(
                        content=ft.Text("Text alignment"),
                        leading=ft.Icon(ft.Icons.LOCATION_PIN),
                        controls=[
                            ft.MenuItemButton(
                                content=ft.Text("bottom_center"),
                                data=ft.Alignment.BOTTOM_CENTER,
                                on_click=handle_alignment_click,
                                style=ft.ButtonStyle(
                                    bgcolor={
                                        ft.ControlState.HOVERED: ft.Colors.GREY_100
                                    }
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("bottom_left"),
                                data=ft.Alignment.BOTTOM_LEFT,
                                on_click=handle_alignment_click,
                                style=ft.ButtonStyle(
                                    bgcolor={
                                        ft.ControlState.HOVERED: ft.Colors.GREY_100
                                    }
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("top_center"),
                                data=ft.Alignment.TOP_CENTER,
                                on_click=handle_alignment_click,
                                style=ft.ButtonStyle(
                                    bgcolor={
                                        ft.ControlState.HOVERED: ft.Colors.GREY_100
                                    }
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("center_left"),
                                data=ft.Alignment.CENTER_LEFT,
                                on_click=handle_alignment_click,
                                style=ft.ButtonStyle(
                                    bgcolor={
                                        ft.ControlState.HOVERED: ft.Colors.GREY_100
                                    }
                                ),
                            ),
                            ft.MenuItemButton(
                                content=ft.Text("center_right"),
                                data=ft.Alignment.CENTER_RIGHT,
                                on_click=handle_alignment_click,
                                style=ft.ButtonStyle(
                                    bgcolor={
                                        ft.ControlState.HOVERED: ft.Colors.GREY_100
                                    }
                                ),
                            ),
                        ],
                    ),
                ],
            )
        ],
    )

    page.add(
        ft.Row(controls=[menubar]),
        background_container := ft.Container(
            expand=True,
            bgcolor=ft.Colors.SURFACE_TINT,
            alignment=ft.Alignment.CENTER,
            content=ft.Text(
                value="Choose a bgcolor from the menu",
                style=ft.TextStyle(size=24, weight=ft.FontWeight.BOLD),
            ),
        ),
    )


ft.run(main)

SubmenuButton

Bases: ConstrainedControl

A menu button that displays a cascading menu.

Typically used in a MenuBar control.

alignment_offset

alignment_offset: OffsetValue | None = None

The offset of the menu relative to the alignment origin determined by MenuStyle.alignment on the style attribute.

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.

clip_behavior

clip_behavior: ClipBehavior = HARD_EDGE

Whether to clip the content of this control or not.

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

content

content: Control | None = None

The child control to be displayed in the middle portion of this button.

Typically this is the button's label, using a Text control.

controls

controls: list[Control] = field(default_factory=list)

A list of controls that appear in the menu when it is opened.

Typically either MenuItemButton or SubMenuButton controls.

If this list is empty, then the button for this menu item will be disabled.

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()
    ]
)

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.

key

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

leading

leading: Control | None = None

An optional control to display before the content.

Typically an Icon control.

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.

menu_style

menu_style: MenuStyle | None = None

Customizes this menu's appearance.

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_blur

on_blur: ControlEventHandler[SubmenuButton] | None = None

Called when this button loses focus.

on_close

on_close: ControlEventHandler[SubmenuButton] | None = None

Called when the menu is closed.

on_focus

on_focus: ControlEventHandler[SubmenuButton] | None = None

Called when the button receives focus.

on_hover

on_hover: ControlEventHandler[SubmenuButton] | None = None

Called when the button is hovered.

on_open

on_open: ControlEventHandler[SubmenuButton] | None = None

Called when the menu is opened.

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).

page

page: Page | PageView | None

The page (of type Page or PageView) 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)
)

style

style: ButtonStyle | None = None

Customizes this button's appearance.

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.

trailing

trailing: Control | None = None

An optional control to display after the content.

Typically an Icon control.

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()

clean

clean() -> None

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

update

update() -> None

will_unmount

will_unmount()