AppBar | Flet中文文档

AppBar 继承自：AdaptiveControl, Control, BaseControl

一个 Material Design 应用栏。

示例：

python

ft.AppBar(
    leading=ft.Icon(ft.Icons.MENU),
    title=ft.Text("Dashboard"),
    bgcolor=ft.Colors.SURFACE_CONTAINER,
    actions=[
        ft.IconButton(ft.Icons.SEARCH),
        ft.IconButton(ft.Icons.MORE_VERT),
    ],
)

示例

python

import flet as ft


def main(page: ft.Page):
    page.title = "AppBar Example"

    def handle_checked_item_click(e: ft.Event[ft.PopupMenuItem]):
        e.control.checked = not e.control.checked

    page.appbar = ft.AppBar(
        leading=ft.Icon(ft.Icons.PALETTE),
        leading_width=40,
        title=ft.Text("AppBar Example"),
        center_title=False,
        bgcolor=ft.Colors.BLUE_GREY_400,
        actions=[
            ft.IconButton(ft.Icons.WB_SUNNY_OUTLINED),
            ft.IconButton(ft.Icons.FILTER_3),
            ft.PopupMenuButton(
                key="popup",
                items=[
                    ft.PopupMenuItem(content="Item 1"),
                    ft.PopupMenuItem(),  # divider
                    ft.PopupMenuItem(
                        content="Checked item",
                        checked=False,
                        on_click=handle_checked_item_click,
                    ),
                ],
            ),
        ],
    )
    page.add(ft.SafeArea(content=ft.Column(controls=[ft.Text("Body!")])))


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

python

import flet as ft

LIGHT_SEED_COLOR = ft.Colors.DEEP_ORANGE
DARK_SEED_COLOR = ft.Colors.DEEP_PURPLE


def main(page: ft.Page):
    page.title = "AppBar Example"

    def handle_checked_item_click(e: ft.Event[ft.PopupMenuItem]):
        e.control.checked = not e.control.checked

    page.theme_mode = ft.ThemeMode.LIGHT
    page.theme = ft.Theme(color_scheme_seed=LIGHT_SEED_COLOR)
    page.dark_theme = ft.Theme(color_scheme_seed=DARK_SEED_COLOR)

    def toggle_theme_mode(e: ft.Event[ft.IconButton]):
        page.theme_mode = (
            ft.ThemeMode.DARK
            if page.theme_mode == ft.ThemeMode.LIGHT
            else ft.ThemeMode.LIGHT
        )
        theme_mode_toggle.icon = (
            ft.Icons.WB_SUNNY_OUTLINED
            if page.theme_mode == ft.ThemeMode.LIGHT
            else ft.Icons.WB_SUNNY
        )

    theme_mode_toggle = ft.IconButton(
        key="theme_mode_toggle",
        icon=(
            ft.Icons.WB_SUNNY_OUTLINED
            if page.theme_mode == ft.ThemeMode.LIGHT
            else ft.Icons.WB_SUNNY
        ),
        on_click=toggle_theme_mode,
    )

    page.padding = 50
    page.appbar = ft.AppBar(
        # toolbar_height=100,
        bgcolor=ft.Colors.SECONDARY_CONTAINER,
        leading=ft.Icon(ft.Icons.PALETTE),
        leading_width=40,
        title=ft.Text("AppBar Example"),
        center_title=False,
        actions=[
            theme_mode_toggle,
            ft.PopupMenuButton(
                items=[
                    ft.PopupMenuItem(content="Item 1"),
                    ft.PopupMenuItem(icon=ft.Icons.POWER_INPUT, content="Check power"),
                    ft.PopupMenuItem(
                        on_click=lambda _: print(
                            "Button with a custom content clicked!"
                        ),
                        content=ft.Row(
                            controls=[
                                ft.Icon(ft.Icons.HOURGLASS_TOP_OUTLINED),
                                ft.Text("Item with a custom content"),
                            ]
                        ),
                    ),
                    ft.PopupMenuItem(),  # divider
                    ft.PopupMenuItem(
                        content="Checked item",
                        checked=False,
                        on_click=handle_checked_item_click,
                    ),
                ]
            ),
        ],
    )
    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Text(
                        value="Flet is a framework that allows building web, desktop "
                        "and mobile applications in Python without prior experience "
                        "in frontend development.You can build a UI for your program "
                        "with Flet controls which are based on Flutter by Google. "
                        "Flet goes beyond merely wrapping Flutter widgets. It adds "
                        "its own touch by combining smaller widgets, simplifying "
                        "complexities, implementing UI best practices, and applying "
                        "sensible defaults. This ensures that your applications look "
                        "stylish and polished without requiring additional design "
                        "efforts on your part.",
                        text_align=ft.TextAlign.END,
                    ),
                    ft.Button("Click me!"),
                ]
            )
        )
    )


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

属性

名称	类型	默认值	说明
`leading`	`Optional[Control]`	`None`	显示在工具栏 `title` 之前的控件。通常是 `Icon` 或 `IconButton` 控件。
`leading_width`	`Optional[Number]`	`None`	定义 `leading` 控件的宽度。
`automatically_imply_leading`	`bool`	`True`	当 `leading` 为 `None` 时，是否应尝试推断 `leading` 控件。 - 如果为 `True` 且 `leading` 为 `None`，此应用栏会自动确定一个合适的 leading 控件。 - 如果为 `False` 且 `leading` 为 `None`，该空间会分配给 `title`。 - 如果提供了 `leading` 控件，则此参数不起作用。
`title`	`Optional[StrOrControl]`	`None`	显示在此应用栏中的主控件。通常是包含当前应用内容说明的 `Text` 控件。注意：如果 `adaptive` 为 `True` 且此应用在 iOS 或 macOS 设备上打开，则无论 `center_title` 的值如何，此 `title` 控件都会自动居中。
`center_title`	`Optional[bool]`	`None`	`title` 是否应居中。默认值由 `center_title` 定义。
`toolbar_height`	`Optional[Number]`	`None`	定义此应用栏工具栏组件的高度。
`color`	`Optional[ColorValue]`	`None`	此应用栏内 `Text` 和 `Icon` 控件的默认颜色。默认颜色由 `color` 定义。
`bgcolor`	`Optional[ColorValue]`	`None`	用于此应用栏的填充色。默认颜色由 `bgcolor` 定义。
`elevation`	`Annotated[Optional[Number], V.ge(0)]`	`None`	应用栏的高度。注意：此效果仅在使用 Material 2 设计（即 `use_material3` 为 `False`）时可见。抛出异常： ValueError：如果它不大于或等于 `0`。
`elevation_on_scroll`	`Annotated[Optional[Number], V.ge(0)]`	`None`	如果此应用栏下方有内容滚动时使用的高度。抛出异常： ValueError：如果它不大于或等于 `0`。
`shadow_color`	`Optional[ColorValue]`	`None`	此应用栏下方阴影的颜色。仅当 `elevation` 大于零时阴影才可见并显示。
`clip_behavior`	`Optional[ClipBehavior]`	`None`	内容将根据此选项被裁剪（或不裁剪）。
`force_material_transparency`	`bool`	`False`	强制此应用栏透明（而非 Material 的默认类型）。这还会移除 `bgcolor` 和 `elevation` 的视觉显示，并影响此应用栏的其他特征。
`secondary`	`bool`	`False`	此应用栏是否不显示在屏幕顶部。
`title_spacing`	`Optional[Number]`	`None`	`title` 在水平轴方向上的间距。即使没有 `leading` 或 `actions` 控件，它也会生效。提示：如果你希望 `title` 占用所有可用空间，请将 `title_spacing` 设为 `0.0`。
`exclude_header_semantics`	`bool`	`False`	`title` 是否应包裹在标题 `Semantics` 中。
`actions`	`Optional[list[Control]]`	`None`	显示在标题控件之后一行中的 `Control` 列表。通常这些控件是表示常用操作的 `IconButton`。对于不太常用的操作，可以考虑将 `PopupMenuButton` 作为最后一个操作。信息：如果 `adaptive` 为 `True` 且此应用在 iOS 或 macOS 设备上打开，这些 `actions` 会自动放置在一个 `Row` 中。这是因为 `trailing`（作为 `actions` 的对应属性）只接受单个 `Control`。
`actions_padding`	`Optional[PaddingValue]`	`None`	`actions` 与此应用栏末端之间的内边距。
`toolbar_opacity`	`Annotated[Number, V.between(0.0, 1.0)]`	`1.0`	工具栏的不透明度。 - `0.0`：透明 - `1.0`：完全不透明抛出异常： ValueError：如果它不在 `0.0` 到 `1.0`（含）之间。
`title_text_style`	`Optional[TextStyle]`	`None`	用于 `title` 中 `Text` 控件的样式。
`toolbar_text_style`	`Optional[TextStyle]`	`None`	用于应用栏 `leading` 和 `actions` 中 `Text` 控件的样式。
`shape`	`Optional[OutlinedBorder]`	`None`	此应用栏 Material 及其阴影的形状。
`adaptive`	`Optional[bool]`	`None`	启用平台特定渲染，或从父控件继承自适应能力。
`expand`	`Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))]`	`None`	指定此控件是否／如何扩展以填满父布局中的可用空间。更多信息见此处。注意：仅当此控件的直接父级是以下控件或其子类时才生效：`Column`、`Row`、`View`、`Page`。抛出异常： ValueError：如果它不是 `bool` 或 `int` 类型。
`expand_loose`	`bool`	`False`	允许控件在主轴方向有可用空间时扩展，但不要求它填满所有可用空间。更多信息见此处。注意：如果 `expand_loose` 为 `True`，则仅在以下条件满足时才生效： - `expand` 不为 `None`，且 - 此控件的直接父级是以下控件或其子类之一：`Column`、`Row`、`View`、`Page`。
`col`	`ResponsiveNumber`	`12`	如果此控件的父级是 `ResponsiveRow`，则此属性决定该控件在屏幕上跨越多少虚拟列。可以是一个数字，也可以是一个按断点配置不同值的字典，例如 `col={"sm": 6}`。值为 `0` 时会在该断点隐藏控件，因此它不会占用父级 `ResponsiveRow` 中的任何列。此控件默认跨越 12 个虚拟列。 \| 断点 \| 尺寸 \| \|---\|---\| \| xs \| <576px \| \| sm \| ≥576px \| \| md \| ≥768px \| \| lg \| ≥992px \| \| xl \| ≥1200px \| \| xxl \| ≥1400px \|
`opacity`	`Annotated[Number, V.between(0.0, 1.0)]`	`1.0`	定义控件的透明度。取值范围从 `0.0`（完全透明）到 `1.0`（完全不透明，无任何透明感）。抛出异常： ValueError：如果它不在 `0.0` 到 `1.0`（含）之间。
`tooltip`	`Optional[TooltipValue]`	`None`	鼠标悬停在此控件上时显示的工具提示。
`badge`	`Optional[BadgeValue]`	`None`	显示在此控件顶部的徽章。
`visible`	`bool`	`True`	每个控件都有 `visible` 属性，默认为 `True` —— 控件会渲染在页面上。将 `visible` 设为 `False` 会彻底阻止控件（及其所有子控件，如果有）渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中，也不会触发任何事件。
`disabled`	`bool`	`False`	每个控件都有 `disabled` 属性，默认为 `False` —— 控件及其所有子控件都处于启用状态。注意：此属性的值会递归向下传播到所有子控件。示例：例如，如果你有一个包含多个输入控件的表单，可以通过禁用容器来一并禁用它们： `python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )`
`rtl`	`bool`	`False`	控件的文本方向是否为从右到左（RTL）。
`data`	`Any`	`skip_`	任意类型的自定义数据。
`key`	`Optional['KeyValue']`	`None`	用于在更新之间保持控件标识稳定的键。

只读属性

名称	类型	默认值	说明
`parent`	`Optional['BaseControl']`	—	此控件的直接祖先（父级）。默认为 `None`，只有在此控件被挂载（加入页面树）后才有值。 `Page` 控件（页面树的根）是个例外 —— 它的 `parent` 始终为 `None`。
`page`	`'Page'`	—	此控件所属的页面。

方法

名称	类型	默认值	说明
`is_isolated`	—	—	返回此控件是否被标记为隔离。隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
`init`	—	—	在控件实例初始化之后、首次 build/update 循环之前调用。重写此钩子可执行依赖于已初始化字段的轻量级设置。请不要在此处调用 `update()`。
`build`	—	—	在控件初始化期间调用一次，用于定义其子控件。在此方法中 `page` 属性可用。
`before_update`	—	—	每当此控件被更新时都会调用此方法。注意：务必不要在此处调用或请求 `update()`。
`before_event`	—	—	在事件处理器执行之前拦截事件。返回 `False` 可取消分发。返回 `True` 或 `None` 则继续正常的事件处理。
`did_mount`	—	—	在控件挂载到页面树之后调用。重写此方法以启动需要已挂载页面的资源，例如订阅、定时器或服务监听器。
`will_unmount`	—	—	在控件从页面树移除之前调用。重写此方法以释放 `did_mount()` 中创建的资源，例如订阅、定时器或外部句柄。
`get_data_channel`	—	—	解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式： on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel，因此重复调用会返回同一实例。没有错误路径：该 id 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
`update`	`None`	—	为此控件请求一次 UI 更新。在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。

托管

托管

示例 ​

属性 ​

只读属性 ​

方法 ​

关注我，学习大模型、大数据、Python等热门技术。

示例

属性

只读属性

方法