Flet中文文档

主题

DateRangePicker 继承自：DialogControl, AdaptiveControl, Control, BaseControl

Material 风格的日期范围选择器对话框。

可以通过调用 show_dialog 方法打开。

根据 entry_mode 的不同，它会显示日历或输入框（文本字段）来选择日期范围。

示例：

python
picker = ft.DateRangePicker()

ft.Button(
    "Pick date range",
    icon=ft.Icons.DATE_RANGE,
    on_click=lambda _: page.show_dialog(picker),
)

示例 ​

python
import datetime

import flet as ft


def main(page: ft.Page):
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER

    messages = ft.Column(tight=True)

    def handle_change(e: ft.Event[ft.DateRangePicker]):
        messages.controls.extend(
            [
                ft.Text(
                    f"Start Date changed: {e.control.start_value.strftime('%m/%d/%Y')}"
                ),
                ft.Text(
                    f"End Date changed: {e.control.end_value.strftime('%m/%d/%Y')}"
                ),
            ]
        )

    def handle_dismissal(_: ft.Event[ft.DialogControl]):
        messages.controls.append(ft.Text("DateRangePicker dismissed"))

    today = datetime.datetime(year=2025, month=4, day=15)

    picker = ft.DateRangePicker(
        start_value=datetime.datetime(year=today.year, month=today.month, day=1),
        end_value=datetime.datetime(year=today.year, month=today.month, day=15),
        first_date=datetime.datetime(year=2024, month=1, day=1),
        last_date=datetime.datetime(year=2026, month=12, day=31),
        current_date=today,
        on_change=handle_change,
        on_dismiss=handle_dismissal,
    )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                controls=[
                    ft.Button(
                        icon=ft.Icons.DATE_RANGE,
                        on_click=lambda _: page.show_dialog(picker),
                        content="Pick date range",
                    ),
                    messages,
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)
基础用法
python
import datetime

import flet as ft


def main(page: ft.Page):
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER

    current_date = datetime.datetime(year=2025, month=4, day=15)

    page.add(
        ft.SafeArea(
            content=ft.Button(
                icon=ft.Icons.CALENDAR_MONTH,
                on_click=lambda _: page.show_dialog(
                    ft.DateRangePicker(
                        locale=ft.Locale("zh", "Hans"),
                        start_value=datetime.datetime(year=2025, month=4, day=10),
                        end_value=datetime.datetime(year=2025, month=4, day=20),
                        first_date=datetime.datetime(year=2024, month=1, day=1),
                        last_date=datetime.datetime(year=2026, month=12, day=31),
                        current_date=current_date,
                    )
                ),
                content="Pick dates (zh_Hans locale)",
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)
自定义区域设置

属性 ​

名称类型默认值说明
start_valueOptional[DateTimeValue]None选择器应显示的已选开始日期。 默认为 current_date。
end_valueOptional[DateTimeValue]None选择器应显示的已选结束日期。 默认为 current_date。
save_textOptional[str]None全屏日历模式下保存按钮上的标签。
error_invalid_range_textOptional[str]None日期范围无效（例如开始日期晚于结束日期）时使用的消息。
modalboolFalse是否禁止通过点击日期选择器外部区域将其关闭。
first_dateDateTimeValuedatetime(year=1900()日期范围中最早允许的日期。
last_dateDateTimeValuedatetime(year=2050()日期范围中最晚允许的日期。
current_dateDateTimeValuedatetime.now(()表示今天的日期。它会在日视图中高亮显示。
localeOptional[Locale]None此日期选择器对话框的区域设置。它用于（罕见的）需要让此对话框的区域设置与页面其余部分不同的情况。 它会覆盖页面使用的区域设置（见 locale_configuration），但不参与页面级的区域设置解析。 如果设为 None（默认）或不存在／不支持的区域设置，则回退使用 locale_configuration 的 current_locale。
keyboard_typeKeyboardTypeKeyboardType.DATETIME用于编辑文本的键盘类型。
entry_modeDatePickerEntryModeDatePickerEntryMode.CALENDAR日期选择器对话框的初始日期输入方式。
help_textOptional[str]None显示在标题顶部的文本。 用于向用户说明他们正在为哪件事选择日期。
cancel_textOptional[str]None显示在取消按钮上的文本。
confirm_textOptional[str]None显示在确认按钮上的文本。
error_format_textOptional[str]None当输入的日期格式不正确时，显示在 TextField 下方的错误消息。
error_invalid_textOptional[str]None当日期早于 first_date 或晚于 last_date 时，显示在 TextField 下方的错误消息。
field_start_hint_textOptional[str]None开始字段中尚未输入文本时，用于提示用户的文本。
field_end_hint_textOptional[str]None结束字段中尚未输入文本时，用于提示用户的文本。
field_start_label_textOptional[str]None开始日期文本输入字段的标签。
field_end_label_textOptional[str]None结束日期文本输入字段的标签。
switch_to_calendar_iconOptional[IconData]None当 entry_mode 为 INPUT 时，显示在对话框角落的图标名称。 点击此图标会将 entry_mode 更改为 CALENDAR。 若为 None，则使用 Icons.CALENDAR_TODAY。
switch_to_input_iconOptional[IconData]None当 entry_mode 为 CALENDAR 时，显示在对话框角落的图标名称。 点击此图标会将 entry_mode 更改为 INPUT。 若为 None，则使用 Icons.EDIT_OUTLINED。
barrier_colorOptional[ColorValue]None使日期选择器下方所有内容变暗的模态遮罩颜色。 若为 None，则使用 barrier_color。若它也为 None，则使用 Colors.BLACK_54。
openboolFalse设为 True 以显示此对话框。
adaptiveOptional[bool]None启用平台特定渲染，或从父控件继承自适应能力。
expandAnnotated[Optional[Union[bool, int]], V.instance_of((bool, int))]None指定此控件是否／如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意： 仅当此控件的直接父级是以下控件或其子类时才生效：Column、Row、View、Page。 抛出异常： ValueError：如果它不是 bool 或 int 类型。
expand_looseboolFalse允许控件在主轴方向有可用空间时扩展，但不要求它填满所有可用空间。 更多信息见此处。 注意： 如果 expand_loose 为 True，则仅在以下条件满足时才生效： - expand 不为 None，且 - 此控件的直接父级是以下控件或其子类之一：Column、Row、View、Page。
colResponsiveNumber12如果此控件的父级是 ResponsiveRow，则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字，也可以是一个按断点配置不同值的字典，例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件，因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacityAnnotated[Number, V.between(0.0, 1.0)]1.0定义控件的透明度。 取值范围从 0.0（完全透明）到 1.0（完全不透明，无任何透明感）。 抛出异常： ValueError：如果它不在 0.0 到 1.0（含）之间。
tooltipOptional[TooltipValue]None鼠标悬停在此控件上时显示的工具提示。
badgeOptional[BadgeValue]None显示在此控件顶部的徽章。
visibleboolTrue每个控件都有 visible 属性，默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件（及其所有子控件，如果有）渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中，也不会触发任何事件。
disabledboolFalse每个控件都有 disabled 属性，默认为 False —— 控件及其所有子控件都处于启用状态。 注意： 此属性的值会递归向下传播到所有子控件。 示例： 例如，如果你有一个包含多个输入控件的表单，可以通过禁用容器来一并禁用它们： python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtlboolFalse控件的文本方向是否为从右到左（RTL）。
dataAnyskip_任意类型的自定义数据。
keyOptional['KeyValue']None用于在更新之间保持控件标识稳定的键。

只读属性 ​

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

事件 ​

名称类型默认值说明
on_changeOptional[ControlEventHandler['DateRangePicker']]None当用户点击确认按钮时调用。 start_value 和 end_value 会更新为所选日期。 事件处理器参数的 data 属性包含所选日期。
on_dismissOptional[ControlEventHandler['DialogControl']]None当对话框被关闭时调用。

方法 ​

名称类型默认值说明
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 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
updateNone—为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。

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

footer-banner