CupertinoDatePicker

Examples

Live example

Basic Example

from datetime import datetime

import flet as ft


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

    def handle_date_change(e: ft.Event[ft.CupertinoDatePicker]):
        message.value = f"Chosen Date: {e.control.value.strftime('%Y-%m-%d %H:%M %p')}"
        page.update()

    cupertino_date_picker = ft.CupertinoDatePicker(
        value=datetime.now(),
        date_picker_mode=ft.CupertinoDatePickerMode.DATE_AND_TIME,
        on_change=handle_date_change,
    )

    page.add(
        ft.CupertinoFilledButton(
            content="Open CupertinoDatePicker",
            on_click=lambda e: page.show_dialog(
                ft.CupertinoBottomSheet(
                    content=cupertino_date_picker,
                    height=216,
                    padding=ft.Padding.only(top=6),
                )
            ),
        ),
        message := ft.Text("Chosen Time: "),
    )


ft.run(main)

CupertinoDatePicker

Bases: ConstrainedControl

An iOS-styled date picker.

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.

bgcolor

bgcolor: ColorValue | None = None

The background color of the date picker.

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.

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

data

data: Any = skip_field()

Arbitrary data of any type.

date_order

date_order: CupertinoDatePickerDateOrder | None = None

The order in which the columns inside this picker are displayed.

Note

The final order in which the columns are displayed is also influenced by the date_picker_mode. For example, if date_picker_mode is CupertinoDatePickerMode.MONTH_YEAR both CupertinoDatePickerDateOrder.DAY_MONTH_YEAR and CupertinoDatePickerDateOrder.MONTH_DAY_YEAR will result in the month|year order.

date_picker_mode

date_picker_mode: CupertinoDatePickerMode = DATE_AND_TIME

The mode of the date picker.

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.

first_date

first_date: DateTimeValue | None = None

The earliest allowable date that the user can select.

Defaults to None - no limit.

When not None (no limit), one can still scroll the picker to dates earlier than first_date, with the exception that the on_change will not be called. Once let go, the picker will scroll back to first_date.

In CupertinoDatePickerMode.TIME mode, a time becomes unselectable if the datetime produced by combining that particular time and the date part of initialDateTime is earlier than last_date. So typically first_date needs to be set to a datetime that is on the same date as initialDateTime.

height

height: Number | None = None

Imposed Control height in virtual pixels.

item_extent

item_extent: Number = 32.0

The uniform height of all children.

key

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

last_date

last_date: DateTimeValue | None = None

The latest allowable date that the user can select.

When not None, one can still scroll the picker to dates later than last_date, with the exception that the on_change will not be called. Once let go, the picker will scroll back to last_date.

In CupertinoDatePickerMode.TIME mode, a time becomes unselectable if the datetime produced by combining that particular time and the date part of initialDateTime is later than last_date. So typically last_date needs to be set to a datetime that is on the same date as initialDateTime.

Defaults to None - no limit.

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.

maximum_year

maximum_year: int | None = None

Maximum year to which the picker can be scrolled when in CupertinoDatePickerMode.DATE mode.

Defaults to None - no limit.

minimum_year

minimum_year: int = 1

Minimum year to which the picker can be scrolled when in CupertinoDatePickerMode.DATE mode.

minute_interval

minute_interval: int = 1

The granularity of the minutes spinner, if it is shown in the current date_picker_mode.

Note

Must be an integer factor of 60.

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_change

on_change: (
    ControlEventHandler[CupertinoDatePicker] | None
) = None

Called when the selected date and/or time changes.

Will not fire if the new selected value is not valid, or is not in the range of first_date and last_date.

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

show_day_of_week

show_day_of_week: bool = False

Whether to show day of week alongside day.

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.

use_24h_format

use_24h_format: bool = False

Whether to use the 24-hour time format.

If False, the 12-hour time format is used.

value

value: DateTimeValue = field(default_factory=lambda: now())

The initial date and/or time of the picker. It must conform to the intervals set in first_date, last_date, min_year, and max_year else an error will be ValueError will be raised.

Defaults to the present date and time.

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