PopupMenuButton

An icon button which displays a menu when clicked.

Inherits: LayoutControl

Properties

bgcolor(ColorValue | None) –

The menu's background color.
clip_behavior(ClipBehavior) –

The content will be clipped (or not) according to this option.
content(StrOrControl | None) –

A Control that will be displayed instead of "more" icon.
elevation(Number | None) –

The menu's elevation when opened.
enable_feedback(bool | None) –

Whether detected gestures should provide acoustic and/or haptic feedback.
icon(IconDataOrControl | None) –

If provided, an icon to draw on the button.
icon_color(ColorValue | None) –

The icon's color.
icon_size(Number | None) –

The icon's size.
items(list[PopupMenuItem]) –

A collection of PopupMenuItem controls to display in a dropdown menu.
menu_padding(PaddingValue | None) –

TBD
menu_position(PopupMenuPosition | None) –

Defines position of the popup menu relative to the button.
padding(PaddingValue) –

TBD
popup_animation_style(AnimationStyle | None) –

TBD
shadow_color(ColorValue | None) –

The color used to paint the shadow below
shape(OutlinedBorder | None) –

The menu's shape.
size_constraints(BoxConstraints | None) –

TBD
splash_radius(Number | None) –

The splash radius.
style(ButtonStyle | None) –

TBD

Events

on_cancel(ControlEventHandler[PopupMenuButton] | None) –

Called when the user dismisses/cancels the popup menu without selecting an item.
on_open(ControlEventHandler[PopupMenuButton] | None) –

Called when the popup menu is shown.
on_select(ControlEventHandler[PopupMenuButton] | None) –

TBD

Examples#

Live example

Basic Example#

import flet as ft


def main(page: ft.Page):
    def handle_check_item_click(e: ft.Event[ft.PopupMenuItem]):
        e.control.checked = not e.control.checked
        page.update()

    page.add(
        ft.PopupMenuButton(
            items=[
                ft.PopupMenuItem(content="Item 1"),
                ft.PopupMenuItem(icon=ft.Icons.POWER_INPUT, content="Check power"),
                ft.PopupMenuItem(
                    content=ft.Row(
                        controls=[
                            ft.Icon(ft.Icons.HOURGLASS_TOP_OUTLINED),
                            ft.Text("Item with a custom content"),
                        ]
                    ),
                    on_click=lambda _: print("Button with custom content clicked!"),
                ),
                ft.PopupMenuItem(),  # divider
                ft.PopupMenuItem(
                    content="Checked item",
                    checked=False,
                    on_click=handle_check_item_click,
                ),
            ]
        )
    )


ft.run(main)

Properties#

bgcolor #

bgcolor: ColorValue | None = None

The menu's background color.

clip_behavior #

clip_behavior: ClipBehavior = NONE

The content will be clipped (or not) according to this option.

content #

content: StrOrControl | None = None

A Control that will be displayed instead of "more" icon.

elevation #

elevation: Number | None = None

The menu's elevation when opened.

Defaults to 8.

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.

icon #

icon: IconDataOrControl | None = None

If provided, an icon to draw on the button.

icon_color #

icon_color: ColorValue | None = None

The icon's color.

icon_size #

icon_size: Number | None = None

The icon's size.

items #

items: list[PopupMenuItem] = field(default_factory=list)

A collection of PopupMenuItem controls to display in a dropdown menu.

menu_padding #

menu_padding: PaddingValue | None = None

TBD

menu_position #

menu_position: PopupMenuPosition | None = None

Defines position of the popup menu relative to the button.

Defaults to PopupMenuPosition.OVER.

padding #

padding: PaddingValue = 8

TBD

popup_animation_style #

popup_animation_style: AnimationStyle | None = None

TBD

shadow_color #

shadow_color: ColorValue | None = None

The color used to paint the shadow below the menu.

shape #

shape: OutlinedBorder | None = None

The menu's shape.

Defaults to CircleBorder(radius=10.0).

size_constraints #

size_constraints: BoxConstraints | None = None

TBD

splash_radius #

splash_radius: Number | None = None

The splash radius.

style #

style: ButtonStyle | None = None

TBD

Events#

on_cancel #

on_cancel: ControlEventHandler[PopupMenuButton] | None = (
    None
)

Called when the user dismisses/cancels the popup menu without selecting an item.

on_open #

on_open: ControlEventHandler[PopupMenuButton] | None = None

Called when the popup menu is shown.

on_select #

on_select: ControlEventHandler[PopupMenuButton] | None = (
    None
)

TBD

Inherits: Control

Properties

checked(bool | None) –

Whether this menu item is checked.
content(StrOrControl | None) –

A Control representing custom content of this menu item.
height(Number) –

The minimum height of this menu item.
icon(IconDataOrControl | None) –

An icon to draw before the text label of this menu item.
label_text_style(TextStyle | None) –

The text style of the label of this menu item.
mouse_cursor(MouseCursor | None) –

The cursor to be displayed when a mouse pointer enters or
padding(PaddingValue | None) –

The padding of this menu item.

Events

on_click(ControlEventHandler[PopupMenuItem] | None) –

Called when a user clicks on this menu item.

Properties#

checked #

checked: bool | None = None

Whether this menu item is checked.

If set to True, a checkmark will be shown on the left of the content.

content #

content: StrOrControl | None = None

A Control representing custom content of this menu item.

height #

height: Number = 48.0

The minimum height of this menu item.

icon #

icon: IconDataOrControl | None = None

An icon to draw before the text label of this menu item.

label_text_style #

label_text_style: TextStyle | None = None

The text style of the label of this menu item.

mouse_cursor #

mouse_cursor: MouseCursor | None = None

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

padding #

padding: PaddingValue | None = None

The padding of this menu item.

Defaults to Padding.symmetric(horizontal=12).

Note

The height value of this menu item may influence the applied padding.

For example, if a height greater than the height of the sum of the padding and a content is provided, then the padding's effect will not be visible.

Events#

on_click #

on_click: ControlEventHandler[PopupMenuItem] | None = None

Called when a user clicks on this menu item.