flet 0.70.0.dev5623__py3-none-any.whl → 0.70.0.dev5771__py3-none-any.whl

flet/controls/material/date_range_picker.py

@@ -0,0 +1,183 @@
+from dataclasses import field
+from datetime import datetime
+from typing import Optional
+
+from flet.controls.base_control import control
+from flet.controls.control_event import (
+    ControlEventHandler,
+)
+from flet.controls.dialog_control import DialogControl
+from flet.controls.duration import DateTimeValue
+from flet.controls.material.date_picker import DatePickerEntryMode
+from flet.controls.material.textfield import KeyboardType
+from flet.controls.types import (
+    ColorValue,
+    IconData,
+)
+
+__all__ = [
+    "DateRangePicker",
+]
+
+
+@control("DateRangePicker")
+class DateRangePicker(DialogControl):
+    """
+    A Material-style date range picker dialog.
+
+    It can be opened by calling [`Page.show_dialog()`][flet.Page.show_dialog] method.
+
+    Depending on the [`date_picker_entry_mode`][(c).], it will show either a Calendar
+    or an Input (TextField) for picking a date range.
+    """
+
+    start_value: Optional[DateTimeValue] = None
+    """
+    The selected start date that the picker should display.
+
+    Defaults to [`current_date`][(c).].
+    """
+
+    end_value: Optional[DateTimeValue] = None
+    """
+    The selected end date that the picker should display.
+
+    Defaults to [`current_date`][(c).].
+    """
+
+    save_text: Optional[str] = None
+    """
+    The label on the save button for the fullscreen calendar mode.
+    """
+
+    error_invalid_range_text: Optional[str] = None
+    """
+    The message used when the date range is invalid (e.g. start date is after end date).
+    """
+
+    modal: bool = False
+    """
+    Whether this date picker cannot be dismissed by clicking the area outside of it.
+    """
+
+    first_date: DateTimeValue = field(
+        default_factory=lambda: datetime(year=1900, month=1, day=1)
+    )
+    """
+    The earliest allowable date on the date range. Defaults to `January 1, 1900`.
+    """
+
+    last_date: DateTimeValue = field(
+        default_factory=lambda: datetime(year=2050, month=1, day=1)
+    )
+    """
+    The latest allowable date on the date range. Defaults to `January 1, 2050`.
+    """
+
+    current_date: DateTimeValue = field(default_factory=lambda: datetime.now())
+    """
+    The date representing today. It will be highlighted in the day grid.
+    """
+
+    keyboard_type: KeyboardType = KeyboardType.DATETIME
+    """
+    The type of keyboard to use for editing the text.
+    """
+
+    date_picker_entry_mode: DatePickerEntryMode = DatePickerEntryMode.CALENDAR
+    """
+    The initial mode of date entry method for the date picker dialog.
+    """
+
+    help_text: Optional[str] = None
+    """
+    The text that is displayed at the top of the header.
+
+    This is used to indicate to the user what they are selecting a date for.
+    """
+
+    cancel_text: Optional[str] = None
+    """
+    The text that is displayed on the cancel button.
+    """
+
+    confirm_text: Optional[str] = None
+    """
+    The text that is displayed on the confirm button.
+    """
+
+    error_format_text: Optional[str] = None
+    """
+    The error message displayed below the TextField if the entered date is not in the
+    correct format.
+    """
+
+    error_invalid_text: Optional[str] = None
+    """
+    The error message displayed below the TextField if the date is earlier than
+    [`first_date`][(c).] or
+    later than [`last_date`][(c).].
+    """
+
+    field_start_hint_text: Optional[str] = None
+    """
+    The text used to prompt the user when no text has been entered in the start field.
+    """
+
+    field_end_hint_text: Optional[str] = None
+    """
+    The text used to prompt the user when no text has been entered in the end field.
+    """
+
+    field_start_label_text: Optional[str] = None
+    """
+    The label for the start date text input field.
+    """
+
+    field_end_label_text: Optional[str] = None
+    """
+    The label for the end date text input field.
+    """
+
+    switch_to_calendar_icon: Optional[IconData] = None
+    """
+    The name of the icon displayed in the corner of the dialog when
+    [`date_picker_entry_mode`][(c).]
+    is [`DatePickerEntryMode.INPUT`][flet.DatePickerEntryMode.INPUT].
+
+    Clicking on this icon changes the `date_picker_entry_mode` to
+    [`DatePickerEntryMode.CALENDAR`][flet.DatePickerEntryMode.CALENDAR].
+
+    If `None`, [`Icons.CALENDAR_TODAY`][flet.Icons.CALENDAR_TODAY] is used.
+    """
+
+    switch_to_input_icon: Optional[IconData] = None
+    """
+    The name of the icon displayed in the corner of the dialog when
+    [`date_picker_entry_mode`][(c).]
+    is [`DatePickerEntryMode.CALENDAR`][flet.DatePickerEntryMode.CALENDAR].
+
+    Clicking on this icon changes the `date_picker_entry_mode` to
+    [`DatePickerEntryMode.INPUT`][flet.DatePickerEntryMode.INPUT].
+
+    If `None`, [`Icons.EDIT_OUTLINED`][flet.Icons.EDIT_OUTLINED] is used.
+    """
+
+    barrier_color: Optional[ColorValue] = None
+    """
+    The color of the modal barrier that
+    darkens everything below the date picker.
+
+    If `None`, the [`DialogTheme.barrier_color`][flet.DialogTheme.barrier_color]
+    is used.
+    If it is also `None`, then `Colors.BLACK_54` is used.
+    """
+
+    on_change: Optional[ControlEventHandler["DateRangePicker"]] = None
+    """
+    Called when user clicks confirm button.
+    [`start_value`][(c).] and
+    [`end_value`][(c).] are updated with selected dates.
+
+    The `data` property of the event handler argument contains the selected dates.
+    """

flet/controls/material/divider.py

@@ -17,8 +17,7 @@ class Divider(Control):
     """
     The color to use when painting the line.
 
-    If `None`, [`DividerTheme.color`][flet.DividerTheme.color] is used.
-    If that's is also `None`, defaults to [`Theme.divider_color`][flet.Theme.divider_color].
+    If `None`, [`DividerTheme.color`][flet.] is used.
     """
 
     height: Optional[Number] = None
@@ -26,7 +25,7 @@ class Divider(Control):
     The divider's height extent. The divider itself is always drawn as a horizontal
     line that is centered within the height specified by this value.
 
-    If `None`, [`DividerTheme.space`][flet.DividerTheme.space] is used.
+    If `None`, [`DividerTheme.space`][flet.] is used.
     If that's is also `None`, defaults to `16.0`.
     """
 
@@ -34,40 +33,42 @@ class Divider(Control):
     """
     The amount of empty space to the leading edge of the divider.
 
-    If `None`, [`DividerTheme.leading_indent`][flet.DividerTheme.leading_indent] is used.
+    If `None`, [`DividerTheme.leading_indent`][flet.] is used.
     If that's is also `None`, defaults to `0.0`.
     """
 
     thickness: Optional[Number] = None
     """
-    The thickness of the line drawn within the divider. 
-    
-    A divider with a thickness of `0.0` is always drawn as a line with a 
+    The thickness of the line drawn within the divider.
+
+    A divider with a thickness of `0.0` is always drawn as a line with a
     height of exactly one device pixel.
 
-    If `None`, [`DividerTheme.thickness`][flet.DividerTheme.thickness] is used.
-    If that's is also `None`, defaults to `0.0`.
+    If `None`, [`DividerTheme.thickness`][flet.] is used.
+    If that is also `None`, defaults to `0.0`.
     """
 
     trailing_indent: Optional[Number] = None
     """
     The amount of empty space to the trailing edge of the divider.
 
-    If `None`, [`DividerTheme.trailing_indent`][flet.DividerTheme.trailing_indent] is used.
-    If that's is also `None`, defaults to `0.0`.
+    If `None`, [`DividerTheme.trailing_indent`][flet.] is used.
+    If that is also `None`, defaults to `0.0`.
     """
 
     def before_update(self):
         super().before_update()
-        assert (
-            self.height is None or self.height >= 0
-        ), f"height must be greater than or equal to 0, got {self.height}"
-        assert (
-            self.thickness is None or self.thickness >= 0
-        ), f"thickness must be greater than or equal to 0, got {self.thickness}"
-        assert (
-            self.leading_indent is None or self.leading_indent >= 0
-        ), f"leading_indent must be greater than or equal to 0, got {self.leading_indent}"
-        assert (
-            self.trailing_indent is None or self.trailing_indent >= 0
-        ), f"trailing_indent must be greater than or equal to 0, got {self.trailing_indent}"
+        assert self.height is None or self.height >= 0, (
+            f"height must be greater than or equal to 0, got {self.height}"
+        )
+        assert self.thickness is None or self.thickness >= 0, (
+            f"thickness must be greater than or equal to 0, got {self.thickness}"
+        )
+        assert self.leading_indent is None or self.leading_indent >= 0, (
+            "leading_indent must be greater than or equal to 0, "
+            f"got {self.leading_indent}"
+        )
+        assert self.trailing_indent is None or self.trailing_indent >= 0, (
+            "trailing_indent must be greater than or equal to 0, "
+            f"got {self.trailing_indent}"
+        )

flet/controls/material/dropdown.py

@@ -34,7 +34,7 @@ class DropdownOption(Control):
 
     key: Optional[str] = None
     """
-    Option's key. If not specified [`text`][flet.DropdownOption.text] will
+    Option's key. If not specified [`text`][(c).] will
     be used as fallback.
     """
 
@@ -83,7 +83,7 @@ class Dropdown(LayoutControl):
 
     value: Optional[str] = None
     """
-    [`key`][flet.DropdownOption.key] value of the selected option.
+    [`key`][(c).] value of the selected option.
     """
 
     options: list[DropdownOption] = field(default_factory=list)
@@ -110,7 +110,7 @@ class Dropdown(LayoutControl):
 
     elevation: Optional[ControlStateValue[Optional[Number]]] = 8
     """
-    The dropdown's menu elevation in various [`ControlState`][flet.ControlState]
+    The dropdown's menu elevation in various [`ControlState`][flet.]
     states.
     """
 
@@ -198,7 +198,7 @@ class Dropdown(LayoutControl):
     bgcolor: Optional[ControlStateValue[ColorValue]] = None
     """
     The background color of the dropdown menu
-    in various [`ControlState`][flet.ControlState]
+    in various [`ControlState`][flet.]
     states.
     """
 
@@ -226,8 +226,8 @@ class Dropdown(LayoutControl):
 
     error_style: Optional[TextStyle] = None
     """
-    The [`TextStyle`][flet.TextStyle] to use for
-    [`error_text`][flet.Dropdown.error_text].
+    The [`TextStyle`][flet.] to use for
+    [`error_text`][(c).].
     """
 
     error_text: Optional[str] = None
@@ -244,7 +244,7 @@ class Dropdown(LayoutControl):
 
     text_style: Optional[TextStyle] = None
     """
-    The [`TextStyle`][flet.TextStyle] to use for text
+    The [`TextStyle`][flet.] to use for text
     in input text field.
     """
 
@@ -261,7 +261,7 @@ class Dropdown(LayoutControl):
 
     label_style: Optional[TextStyle] = None
     """
-    The [`label`][flet.Dropdown.label]'s text style.
+    The [`label`][(c).]'s text style.
     """
 
     border: Optional[InputBorder] = None
@@ -317,7 +317,7 @@ class Dropdown(LayoutControl):
     filled: bool = False
     """
     Whether the decoration's container is filled with theme
-    [`fill_color`][flet.Dropdown.fill_color].
+    [`fill_color`][(c).].
     """
 
     fill_color: Optional[ColorValue] = None
@@ -345,8 +345,8 @@ class Dropdown(LayoutControl):
 
     hint_style: Optional[TextStyle] = None
     """
-    The [`TextStyle`][flet.TextStyle] to use for
-    [`hint_text`][flet.Dropdown.hint_text].
+    The [`TextStyle`][flet.] to use for
+    [`hint_text`][(c).].
     """
 
     helper_text: Optional[str] = None
@@ -361,8 +361,8 @@ class Dropdown(LayoutControl):
 
     helper_style: Optional[TextStyle] = None
     """
-    The [`TextStyle`][flet.TextStyle] to use for
-    [`helper_text`][flet.Dropdown.helper_text].
+    The [`TextStyle`][flet.] to use for
+    [`helper_text`][(c).].
     """
 
     def __contains__(self, item):

flet/controls/material/expansion_tile.py

@@ -39,21 +39,21 @@ class ExpansionTile(LayoutControl, AdaptiveControl):
     """
     A `Control` to display as primary content of the tile.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     controls: Optional[list[Control]] = None
     """
     The controls to be displayed when the tile expands.
 
-    Typically a list of [`ListTile`][flet.ListTile] controls.
+    Typically a list of [`ListTile`][flet.] controls.
     """
 
     subtitle: Optional[StrOrControl] = None
     """
     Additional content displayed below the title.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     leading: Optional[IconDataOrControl] = None
@@ -65,7 +65,7 @@ class ExpansionTile(LayoutControl, AdaptiveControl):
     """
     A `Control` to display after the title.
 
-    Typically an [`Icon`][flet.Icon] control.
+    Typically an [`Icon`][flet.] control.
     """
 
     controls_padding: Optional[PaddingValue] = None
@@ -163,8 +163,7 @@ class ExpansionTile(LayoutControl, AdaptiveControl):
 
     collapsed_shape: Optional[OutlinedBorder] = None
     """
-    The tile's border shape when the sublist is collapsed. The value is an instance
-    of [`OutlinedBorder`][flet.OutlinedBorder]
+    The tile's border shape when the sublist is collapsed.
     """
 
     dense: Optional[bool] = None

flet/controls/material/filled_button.py

@@ -6,7 +6,7 @@ from flet.controls.material.button import Button
 class FilledButton(Button):
     """
     Filled buttons have the most visual impact after the
-    [`FloatingActionButton`][flet.FloatingActionButton], and is typically used for
+    [`FloatingActionButton`][flet.], and is typically used for
     important, final actions that complete a flow, like "Save",
     "Join now", or "Confirm".
     """

flet/controls/material/floating_action_button.py

@@ -85,7 +85,7 @@ class FloatingActionButton(LayoutControl):
 
     clip_behavior: ClipBehavior = ClipBehavior.NONE
     """
-    Defines how the [`content`][flet.FloatingActionButton.content] is clipped.
+    Defines how the [`content`][(c).] is clipped.
     """
 
     elevation: Optional[Number] = None
@@ -144,7 +144,7 @@ class FloatingActionButton(LayoutControl):
     """
     The URL to open when this button is clicked.
 
-    Additionally, if [`on_click`][flet.FloatingActionButton.on_click] event callback
+    Additionally, if [`on_click`][(c).] event callback
     is provided, it is fired after that.
     """