flet 0.70.0.dev6214__py3-none-any.whl → 0.70.0.dev6268__py3-none-any.whl

flet/controls/cupertino/cupertino_date_picker.py

@@ -34,15 +34,6 @@ class CupertinoDatePickerDateOrder(Enum):
 class CupertinoDatePicker(LayoutControl):
     """
     An iOS-styled date picker.
-
-    Raises:
-        ValueError: If [`item_extent`][(c).] is not strictly greater than `0`.
-        ValueError: If [`minute_interval`][(c).] is not a positive integer
-            factor of `60`.
-        ValueError: If [`value`][(c).] is before [`first_date`][(c).] or
-            after [`last_date`][(c).].
-        ValueError: If [`value`][(c).] year is less than [`minimum_year`][(c).] or
-            greater than [`maximum_year`][(c).].
     """
 
     value: DateTimeValue = field(default_factory=lambda: datetime.now())
@@ -54,6 +45,14 @@ class CupertinoDatePicker(LayoutControl):
     else a `ValueError` will be raised.
 
     Defaults to the present date and time.
+
+    Raises:
+        ValueError: If [`value`][(c).] is before [`first_date`][(c).] or
+            after [`last_date`][(c).].
+        ValueError: If [`value`][(c).] year is less than [`minimum_year`][(c).] or
+            greater than [`maximum_year`][(c).].
+        ValueError: If [`value`][(c).] minute is not divisible by
+            [`minute_interval`][(c).].
     """
 
     first_date: Optional[DateTimeValue] = None
@@ -100,12 +99,19 @@ class CupertinoDatePicker(LayoutControl):
 
     Note:
         Must be an integer factor of `60`.
+
+    Raises:
+        ValueError: If [`minute_interval`][(c).] is not a positive integer factor of
+            `60`.
     """
 
     minimum_year: int = 1
     """
     Minimum year to which the picker can be scrolled when in
     [`CupertinoDatePickerMode.DATE`][flet.] mode.
+
+    Raises:
+        ValueError: If [`value`][(c).] year is less than [`minimum_year`][(c).].
     """
 
     maximum_year: Optional[int] = None
@@ -114,11 +120,17 @@ class CupertinoDatePicker(LayoutControl):
     [`CupertinoDatePickerMode.DATE`][flet.] mode.
 
     Defaults to `None` - no limit.
+
+    Raises:
+        ValueError: If [`value`][(c).] year is greater than [`maximum_year`][(c).].
     """
 
     item_extent: Number = 32.0
     """
     The uniform height of all children.
+
+    Raises:
+        ValueError: If [`item_extent`][(c).] is not strictly greater than `0`.
     """
 
     use_24h_format: bool = False
@@ -131,6 +143,11 @@ class CupertinoDatePicker(LayoutControl):
     show_day_of_week: bool = False
     """
     Whether to show day of week alongside day.
+
+    Raises:
+        ValueError: If [`show_day_of_week`][(c).] is set when
+            [`date_picker_mode`][(c).] is not
+            [`CupertinoDatePickerMode.DATE`][flet.].
     """
 
     date_picker_mode: CupertinoDatePickerMode = CupertinoDatePickerMode.DATE_AND_TIME

flet/controls/cupertino/cupertino_dialog_action.py

@@ -15,14 +15,14 @@ class CupertinoDialogAction(Control):
     A dialog action button.
 
     Typically used as a child of [`CupertinoAlertDialog.actions`][flet.].
-
-    Raises:
-        ValueError: If [`content`][(c).] is neither a string nor a visible Control.
     """
 
     content: StrOrControl
     """
     The content of this action button.
+
+    Raises:
+        ValueError: If [`content`][(c).] is neither a string nor a visible Control.
     """
 
     default: bool = False

flet/controls/cupertino/cupertino_filled_button.py

@@ -8,4 +8,8 @@ __all__ = ["CupertinoFilledButton"]
 class CupertinoFilledButton(CupertinoButton):
     """
     An iOS-style button filled with default background color.
+
+    ```python
+    ft.CupertinoFilledButton("Tap me")
+    ```
     """

flet/controls/cupertino/cupertino_list_tile.py

@@ -20,10 +20,18 @@ class CupertinoListTile(LayoutControl):
     """
     An iOS-style list tile.
 
-    Can also serve as a cupertino equivalent of the Material [`ListTile`][flet.].
+    The CupertinoListTile is a Cupertino equivalent of the Material [`ListTile`][flet.].
 
-    Raises:
-        ValueError: If [`title`][(c).] is neither a string nor a visible Control.
+    ```python
+    ft.CupertinoListTile(
+        title="Notifications",
+        subtitle="Enabled",
+        width=400,
+        leading=ft.Icon(ft.Icons.NOTIFICATIONS_OUTLINED),
+        trailing=ft.Icon(ft.Icons.CHEVRON_RIGHT),
+        bgcolor=ft.Colors.SURFACE_CONTAINER_LOW,
+    )
+    ```
     """
 
     title: StrOrControl
@@ -31,6 +39,9 @@ class CupertinoListTile(LayoutControl):
     The primary content of this list tile.
 
     Typically a [`Text`][flet.] control.
+
+    Raises:
+        ValueError: If [`title`][(c).] is neither a string nor a visible Control.
     """
 
     subtitle: Optional[StrOrControl] = None

flet/controls/cupertino/cupertino_navigation_bar.py

@@ -21,11 +21,6 @@ class CupertinoNavigationBar(LayoutControl):
 
     Navigation bars offer a persistent and convenient way to switch between primary
     destinations in an app.
-
-    Raises:
-        ValueError: If [`destinations`][(c).] does not contain at least two visible
-            [`NavigationBarDestination`][flet.]s.
-        IndexError: If [`selected_index`][(c).] is out of range.
     """
 
     destinations: list[NavigationBarDestination]
@@ -34,6 +29,10 @@ class CupertinoNavigationBar(LayoutControl):
 
     Note:
         Must be a list of two or more [`NavigationBarDestination`][flet.]s.
+
+    Raises:
+        ValueError: If [`destinations`][(c).] does not contain at least two visible
+            [`NavigationBarDestination`][flet.]s.
     """
 
     selected_index: int = 0
@@ -44,6 +43,10 @@ class CupertinoNavigationBar(LayoutControl):
     Note:
         Must be a value between `0` and the length of visible
         [`destinations`][(c).], inclusive.
+
+    Raises:
+        IndexError: If [`selected_index`][(c).] is out of range relative to the
+            visible destinations.
     """
 
     bgcolor: Optional[ColorValue] = None

flet/controls/cupertino/cupertino_picker.py

@@ -18,10 +18,6 @@ __all__ = ["CupertinoPicker"]
 class CupertinoPicker(LayoutControl):
     """
     An iOS-styled picker.
-
-    Raises:
-        ValueError: If [`item_extent`][(c).], [`squeeze`][(c).],
-            or [`magnification`][(c).] is not strictly greater than `0.0`.
     """
 
     controls: list[Control] = field(default_factory=list)
@@ -32,6 +28,9 @@ class CupertinoPicker(LayoutControl):
     item_extent: Number = 32.0
     """
     The uniform height of all [`controls`][(c).].
+
+    Raises:
+        ValueError: If [`item_extent`][(c).] is not strictly greater than `0.0`.
     """
 
     selected_index: int = 0
@@ -64,11 +63,17 @@ class CupertinoPicker(LayoutControl):
 
     Note:
         Has effect only if [`use_magnifier`][(c).] is `True`.
+
+    Raises:
+        ValueError: If [`magnification`][(c).] is not strictly greater than `0.0`.
     """
 
     squeeze: Number = 1.45
     """
     The angular compactness of the children on the wheel.
+
+    Raises:
+        ValueError: If [`squeeze`][(c).] is not strictly greater than `0.0`.
     """
 
     diameter_ratio: Number = 1.07

flet/controls/cupertino/cupertino_radio.py

@@ -18,6 +18,20 @@ class CupertinoRadio(LayoutControl):
     """
     A macOS-styled radio button, allowing the user to select a single option from two
     or more choices.
+
+    ```python
+    ft.RadioGroup(
+        value="option_2",
+        content=ft.Column(
+            intrinsic_width=True,
+            controls=[
+                ft.CupertinoRadio(value="option_1", label="Option 1"),
+                ft.CupertinoRadio(value="option_2", label="Option 2"),
+                ft.CupertinoRadio(value="option_3", label="Option 3"),
+            ],
+        ),
+    )
+    ```
     """
 
     label: Optional[str] = None

flet/controls/cupertino/cupertino_segmented_button.py

@@ -15,10 +15,16 @@ class CupertinoSegmentedButton(LayoutControl):
     """
     An iOS-style segmented button.
 
-    Raises:
-        ValueError: If [`controls`][(c).] does not contain at least two visible
-            controls.
-        IndexError: If [`selected_index`][(c).] is out of range.
+    ```python
+    ft.CupertinoSegmentedButton(
+        controls=[
+            ft.Text("One"),
+            ft.Text("Two"),
+            ft.Text("Three"),
+        ],
+        selected_index=1,
+    )
+    ```
     """
 
     controls: list[Control]
@@ -27,12 +33,20 @@ class CupertinoSegmentedButton(LayoutControl):
 
     Note:
         Must contain at least two visible Controls.
+
+    Raises:
+        ValueError: If [`controls`][(c).] does not contain at least two visible
+            controls.
     """
 
     selected_index: int = 0
     """
     The index (starting from 0) of the selected segment in the
     [`controls`][(c).] list.
+
+    Raises:
+        IndexError: If [`selected_index`][(c).] is out of range relative to the
+            visible controls.
     """
 
     selected_color: Optional[ColorValue] = None

flet/controls/cupertino/cupertino_slider.py

@@ -23,10 +23,9 @@ class CupertinoSlider(LayoutControl):
     brightness), or when people would benefit from instant feedback on the effect of
     setting changes.
 
-    Raises:
-        ValueError: If [`min`][(c).] is greater than [`max`][(c).].
-        ValueError: If [`value`][(c).] is less than [`min`][(c).].
-        ValueError: If [`value`][(c).] is greater than [`max`][(c).].
+    ```python
+    ft.CupertinoSlider(value=0.6)
+    ```
     """
 
     value: Optional[Number] = None
@@ -34,6 +33,10 @@ class CupertinoSlider(LayoutControl):
     The currently selected value for this slider.
 
     The slider's thumb is drawn at a position that corresponds to this value.
+
+    Raises:
+        ValueError: If [`value`][(c).] is less than [`min`][(c).] or greater than
+            [`max`][(c).].
     """
 
     min: Number = 0.0
@@ -43,6 +46,9 @@ class CupertinoSlider(LayoutControl):
     Note:
         - Must be less than or equal to [`max`][(c).].
         - If the [`max`][(c).] is equal to the `min`, then this slider is disabled.
+
+    Raises:
+        ValueError: If [`min`][(c).] is greater than [`max`][(c).].
     """
 
     max: Number = 1.0
@@ -52,6 +58,9 @@ class CupertinoSlider(LayoutControl):
     Note:
         - Must be greater than or equal to [`min`][(c).].
         - If the [`min`][(c).] is equal to the `max`, then this slider is disabled.
+
+    Raises:
+        ValueError: If [`max`][(c).] is less than [`min`][(c).].
     """
 
     divisions: Optional[int] = None

flet/controls/cupertino/cupertino_sliding_segmented_button.py

@@ -19,10 +19,16 @@ class CupertinoSlidingSegmentedButton(LayoutControl):
     """
     A cupertino sliding segmented button.
 
-    Raises:
-        ValueError: If [`controls`][(c).] does not contain at least two
-            visible controls.
-        IndexError: If [`selected_index`][(c).] is out of range.
+    ```python
+    ft.CupertinoSlidingSegmentedButton(
+        controls=[
+            ft.Text("One"),
+            ft.Text("Two"),
+            ft.Text("Three"),
+        ],
+        selected_index=1,
+    )
+    ```
     """
 
     controls: list[Control]
@@ -31,11 +37,19 @@ class CupertinoSlidingSegmentedButton(LayoutControl):
 
     Note:
         Must contain at least two visible Controls.
+
+    Raises:
+        ValueError: If [`controls`][(c).] does not contain at least two
+            visible controls.
     """
 
     selected_index: int = 0
     """
     The index (starting from 0) of the selected segment in the [`controls`][(c).] list.
+
+    Raises:
+        IndexError: If [`selected_index`][(c).] is out of range relative to the
+            visible controls.
     """
 
     bgcolor: ColorValue = CupertinoColors.TERTIARY_SYSTEM_FILL

flet/controls/cupertino/cupertino_switch.py

@@ -20,6 +20,10 @@ class CupertinoSwitch(LayoutControl):
     An iOS-style switch.
 
     Used to toggle the on/off state of a single setting.
+
+    ```python
+    ft.CupertinoSwitch(value=True)
+    ```
     """
 
     label: Optional[str] = None

flet/controls/cupertino/cupertino_textfield.py

@@ -24,6 +24,10 @@ class OverlayVisibilityMode(Enum):
 class CupertinoTextField(TextField):
     """
     An iOS-style text field.
+
+    ```python
+    ft.CupertinoTextField(placeholder_text="Search")
+    ```
     """
 
     placeholder_text: Optional[str] = None

flet/controls/cupertino/cupertino_timer_picker.py

@@ -25,19 +25,6 @@ class CupertinoTimerPicker(LayoutControl):
 
     It can show a countdown duration with hour, minute and second spinners. The
     duration is bound between `0` and `23` hours `59` minutes `59` seconds.
-
-    Raises:
-        ValueError: If [`value`][(c).] is negative.
-        ValueError: If [`value`][(c).] is 24 hours or more.
-        ValueError: If [`minute_interval`][(c).] is not a positive integer
-            factor of `60`.
-        ValueError: If [`second_interval`][(c).] is not a positive integer
-            factor of `60`.
-        ValueError: If [`value`][(c).] is not a multiple
-            of [`minute_interval`][(c).].
-        ValueError: If [`value`][(c).] is not a multiple
-            of [`second_interval`][(c).].
-        ValueError: If [`item_extent`][(c).] is not strictly greater than `0.0`.
     """
 
     value: DurationValue = field(default_factory=lambda: Duration())
@@ -45,6 +32,11 @@ class CupertinoTimerPicker(LayoutControl):
     The initial duration of the countdown timer.
 
     If specified as an integer, it will be assumed to be in seconds.
+
+    Raises:
+        ValueError: If [`value`][(c).] is negative or 24 hours or more.
+        ValueError: If [`value`][(c).] is not a multiple
+            of [`minute_interval`][(c).] or [`second_interval`][(c).].
     """
 
     alignment: Alignment = field(default_factory=lambda: Alignment.CENTER)
@@ -58,6 +50,10 @@ class CupertinoTimerPicker(LayoutControl):
 
     Note:
         Must be a positive integer factor of `60`.
+
+    Raises:
+        ValueError: If [`second_interval`][(c).] is not a positive integer factor of
+            `60`.
     """
 
     minute_interval: int = 1
@@ -66,6 +62,10 @@ class CupertinoTimerPicker(LayoutControl):
 
     Note:
         Must be a positive integer factor of `60`.
+
+    Raises:
+        ValueError: If [`minute_interval`][(c).] is not a positive integer factor of
+            `60`.
     """
 
     mode: CupertinoTimerPickerMode = CupertinoTimerPickerMode.HOUR_MINUTE_SECONDS
@@ -81,6 +81,9 @@ class CupertinoTimerPicker(LayoutControl):
     item_extent: Number = 32.0
     """
     The uniform height of all children.
+
+    Raises:
+        ValueError: If [`item_extent`][(c).] is not strictly greater than `0.0`.
     """
 
     on_change: Optional[ControlEventHandler["CupertinoTimerPicker"]] = None

flet/controls/cupertino/cupertino_tinted_button.py

@@ -8,4 +8,8 @@ __all__ = ["CupertinoTintedButton"]
 class CupertinoTintedButton(CupertinoButton):
     """
     An iOS-style button filled with default background color.
+
+    ```python
+    ft.CupertinoTintedButton("Tap me")
+    ```
     """

flet/controls/material/alert_dialog.py

@@ -27,10 +27,6 @@ class AlertDialog(DialogControl):
     It has an optional [`title`][(c).] and an optional list of [`actions`][(c).] . The
     `title` is displayed above the [`content`][(c).] and the `actions` are displayed
     below the `content`.
-
-    Raises:
-        ValueError: If none of [`title`][(c).], [`content`][(c).], or
-            [`actions`][(c).] are provided, as the dialog would have nothing to display.
     """
 
     content: Optional[Control] = None
@@ -59,6 +55,10 @@ class AlertDialog(DialogControl):
     A set of actions that are displayed at the bottom of this dialog.
 
     Typically this is a list of [`TextButton`][flet.] controls.
+
+    Raises:
+        ValueError: If none of [`title`][(c).], [`content`][(c).], or
+            [`actions`][(c).] are provided, as the dialog would have nothing to display.
     """
 
     bgcolor: Optional[ColorValue] = None

flet/controls/material/app_bar.py

@@ -18,12 +18,6 @@ from flet.controls.types import (
 class AppBar(AdaptiveControl):
     """
     A material design app bar.
-
-    Raises:
-        ValueError: If [`elevation`][(c).] is negative.
-        ValueError: If [`elevation_on_scroll`][(c).] is negative.
-        ValueError: If [`toolbar_opacity`][(c).] is not between `0.0`
-            and `1.0` inclusive.
     """
 
     leading: Optional[Control] = None
@@ -95,11 +89,17 @@ class AppBar(AdaptiveControl):
     Note:
         This effect is only visible when using the Material 2 design
         (when [`Theme.use_material3`][flet.] is `False`).
+
+    Raises:
+        ValueError: If [`elevation`][(c).] is negative.
     """
 
     elevation_on_scroll: Optional[Number] = None
     """
     The elevation to be used if this app bar has something scrolled underneath it.
+
+    Raises:
+        ValueError: If [`elevation_on_scroll`][(c).] is negative.
     """
 
     shadow_color: Optional[ColorValue] = None
@@ -173,6 +173,10 @@ class AppBar(AdaptiveControl):
 
     Note:
         Must be in the range `0.0` (transparent) to `1.0` (fully opaque).
+
+    Raises:
+        ValueError: If [`toolbar_opacity`][(c).] is not between `0.0`
+            and `1.0` inclusive.
     """
 
     title_text_style: Optional[TextStyle] = None

flet/controls/material/banner.py

@@ -26,12 +26,6 @@ class Banner(DialogControl):
     Banners are displayed at the top of the screen, below a top app bar. They are
     persistent and non-modal, allowing the user to either ignore them or interact with
     them at any time.
-
-    Raises:
-        ValueError: if [`content`][(c).] is not visible.
-        ValueError: if [`elevation`][(c).] is negative.
-        ValueError: if [`actions`][(c).] does not contain at least one visible
-            action Control.
     """
 
     content: StrOrControl
@@ -39,6 +33,9 @@ class Banner(DialogControl):
     The content of this banner.
 
     Typically a [`Text`][flet.] control.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     actions: list[Control]
@@ -47,6 +44,10 @@ class Banner(DialogControl):
 
     Typically this is a list of [`TextButton`][flet.]
     controls.
+
+    Raises:
+        ValueError: If [`actions`][(c).] does not contain at least one visible
+            action Control.
     """
 
     leading: Optional[IconDataOrControl] = None
@@ -104,6 +105,9 @@ class Banner(DialogControl):
     elevation: Optional[Number] = None
     """
     The elevation of this banner.
+
+    Raises:
+        ValueError: If [`elevation`][(c).] is negative.
     """
 
     margin: Optional[MarginValue] = None

flet/controls/material/bottom_app_bar.py

@@ -18,9 +18,6 @@ __all__ = ["BottomAppBar"]
 class BottomAppBar(LayoutControl):
     """
     A material design bottom app bar.
-
-    Raises:
-        ValueError: If [`elevation`][(c).] is negative.
     """
 
     content: Optional[Control] = None
@@ -70,6 +67,9 @@ class BottomAppBar(LayoutControl):
     elevation: Optional[Number] = None
     """
     This property controls the size of the shadow below this app bar.
+
+    Raises:
+        ValueError: If [`elevation`][(c).] is negative.
     """
 
     def before_update(self):

flet/controls/material/bottom_sheet.py

@@ -18,9 +18,6 @@ class BottomSheet(DialogControl):
 
     A bottom sheet is an alternative to a menu or dialog and prevents the user
     from interacting with the rest of the app.
-
-    Raises:
-        ValueError: If [`elevation`][(c).] is negative.
     """
 
     content: Control
@@ -31,6 +28,9 @@ class BottomSheet(DialogControl):
     elevation: Optional[Number] = None
     """
     Defines the size of the shadow below this bottom sheet.
+
+    Raises:
+        ValueError: If [`elevation`][(c).] is negative.
     """
 
     bgcolor: Optional[ColorValue] = None

flet/controls/material/card.py

@@ -22,6 +22,21 @@ class Card(LayoutControl, AdaptiveControl):
     """
     A material design card: a panel with slightly rounded corners and an elevation
     shadow.
+
+    ```python
+    ft.Card(
+        shadow_color=ft.Colors.ON_SURFACE_VARIANT,
+        content=ft.Container(
+            width=400,
+            padding=10,
+            content=ft.ListTile(
+                bgcolor=ft.Colors.GREY_400,
+                leading=ft.Icon(ft.Icons.FOREST),
+                title=ft.Text("Card Name"),
+            ),
+        ),
+    )
+    ```
     """
 
     content: Optional[Control] = None

flet/controls/material/checkbox.py

@@ -25,6 +25,12 @@ class Checkbox(LayoutControl, AdaptiveControl):
     """
     Checkbox allows to select one or more items from a group, or switch between two
     mutually exclusive options (checked or unchecked, on or off).
+
+    ```python
+    ft.Checkbox()
+    ft.Checkbox(label="Checked", value=True)
+    ft.Checkbox(label="Disabled", disabled=True)
+    ```
     """
 
     label: Optional[StrOrControl] = None