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

flet/controls/base_control.py

@@ -60,7 +60,7 @@ def control(
         isolated: If `True`, marks the control as isolated. An isolated control
             is excluded from page updates when its parent control is updated.
         post_init_args: Number of InitVar arguments to pass to __post_init__.
-        **dataclass_kwargs: Additional keyword arguments passed to `@dataclass`.
+        dataclass_kwargs: Additional keyword arguments passed to `@dataclass`.
 
     Usage:
         - Supports `@control` (without parentheses)

flet/controls/border.py

@@ -51,9 +51,6 @@ class BorderSide:
     Creates the side of a border.
 
     By default, the border is `1.0` logical pixels wide and solid black color.
-
-    Raises:
-        AssertionError: if [`width`][(c).] is negative.
     """
 
     width: Number = 1.0
@@ -69,6 +66,9 @@ class BorderSide:
     Tip:
         To omit the border entirely, set the [`style`][(c).]
         to [`BorderStyle.NONE`][flet.].
+
+    Raises:
+        AssertionError: If [`width`][(c).] is negative.
     """
 
     color: ColorValue = Colors.BLACK

flet/controls/control.py

@@ -15,10 +15,6 @@ class Control(BaseControl):
     Base class for controls.
 
     Not meant to be used directly.
-
-    Raises:
-        ValueError: If [`opacity`][(c).] is not between `0.0` and `1.0` inclusive.
-        ValueError: If [`expand`][(c).] is not None and not of type `bool` or `int`.
     """
 
     expand: Optional[Union[bool, int]] = None
@@ -33,6 +29,9 @@ class Control(BaseControl):
         Has effect only if the direct parent of this control is one of the following
         controls, or their subclasses: [`Column`][flet.], [`Row`][flet.],
         [`View`][flet.], [`Page`][flet.].
+
+    Raises:
+        ValueError: If [`expand`][(c).] is not `None` and not of type `bool` or `int`.
     """
 
     expand_loose: bool = False
@@ -83,6 +82,9 @@ class Control(BaseControl):
 
     Value ranges from `0.0` (completely transparent) to `1.0` (completely opaque
     without any transparency).
+
+    Raises:
+        ValueError: If [`opacity`][(c).] is not between `0.0` and `1.0` inclusive.
     """
 
     tooltip: Optional[TooltipValue] = None

flet/controls/core/animated_switcher.py

@@ -20,9 +20,6 @@ class AnimatedSwitcherTransition(Enum):
 class AnimatedSwitcher(LayoutControl):
     """
     Used to switch between controls with an animation.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
@@ -31,6 +28,9 @@ class AnimatedSwitcher(LayoutControl):
 
     When it changes, this switcher will animate the transition from the old/previous
     `content` to the new one.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     duration: DurationValue = field(default_factory=lambda: Duration(seconds=1))

flet/controls/core/autofill_group.py

@@ -84,14 +84,16 @@ class AutofillGroupDisposeAction(Enum):
 class AutofillGroup(Control):
     """
     Used to group autofill controls together.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
     """
     The content of this group.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     dispose_action: AutofillGroupDisposeAction = AutofillGroupDisposeAction.COMMIT

flet/controls/core/column.py

@@ -13,8 +13,21 @@ __all__ = ["Column"]
 @control("Column")
 class Column(LayoutControl, ScrollableControl, AdaptiveControl):
     """
-    Container allows to decorate a control with background color and border and
-    position it with padding, margin and alignment.
+    Arranges child controls vertically, optionally aligning and spacing them within
+    the available space.
+
+    ```python
+    ft.Column(
+        width=220,
+        height=120,
+        spacing=12,
+        controls=[
+            ft.Text("Daily planning", size=20, weight=ft.FontWeight.W_600),
+            ft.Text("Review pull requests"),
+            ft.Text("Ship release"),
+        ],
+    )
+    ```
     """
 
     controls: list[Control] = field(default_factory=list)

flet/controls/core/dismissible.py

@@ -44,16 +44,16 @@ class Dismissible(LayoutControl, AdaptiveControl):
     this control further animates its height (or width, depending on what is
     perpendicular to the [`dismiss_direction`][(c).]), gradually reducing it to zero
     over the specified [`resize_duration`][(c).].
-
-    Raises:
-        ValueError: If the [`content`][(c).] is not visible.
-        ValueError: If the [`secondary_background`][(c).] is provided and visible
-            but the [`background`][(c).] is not provided and visible.
     """
 
     content: Control
     """
     The control that is being dismissed.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If the [`content`][(c).] is not visible.
     """
 
     background: Optional[Control] = None
@@ -73,6 +73,10 @@ class Dismissible(LayoutControl, AdaptiveControl):
     Note:
         Can only be specified if [`background`][(c).] is also
         specified/visible.
+
+    Raises:
+        ValueError: If the [`secondary_background`][(c).] is provided and visible
+            but the [`background`][(c).] is not provided and visible.
     """
 
     dismiss_direction: DismissDirection = DismissDirection.HORIZONTAL

flet/controls/core/drag_target.py

@@ -57,14 +57,16 @@ class DragTarget(Control):
     does drop the `Draggable` on top of the `DragTarget` (and the `DragTarget` has
     indicated that it will accept the `Draggable`'s data), then the `DragTarget` is
     asked to accept the `Draggable`'s data.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
     """
     The content of this control.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     group: str = "default"

flet/controls/core/draggable.py

@@ -17,10 +17,6 @@ class Draggable(Control):
     [`content_feedback`][(c).] control that tracks the user's finger across the screen.
     If the user lifts their finger while on top of a `DragTarget`, this target is
     given the opportunity to complete drag-and-drop flow.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
-        ValueError: If [`max_simultaneous_drags`][(c).] is set to a negative value.
     """
 
     content: Control
@@ -29,6 +25,9 @@ class Draggable(Control):
 
     If the draggable is being dragged, the
     [`content_when_dragging`][(c).] is displayed instead.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     group: str = "default"
@@ -87,6 +86,9 @@ class Draggable(Control):
         to visually indicate the item is being moved.
     - Set to any positive integer to allow that many concurrent drags.
     - If `None`, there is no limit on the number of simultaneous drags.
+
+    Raises:
+        ValueError: If [`max_simultaneous_drags`][(c).] is set to a negative value.
     """
 
     on_drag_start: Optional[ControlEventHandler["Draggable"]] = None

flet/controls/core/grid_view.py

@@ -20,6 +20,28 @@ class GridView(LayoutControl, ScrollableControl, AdaptiveControl):
     It is very effective for large lists (thousands of items).
     Prefer it over wrapping [`Column`][flet.]s or
     [`Row`][flet.]s for smooth scrolling.
+
+    ```python
+    ft.GridView(
+        width=180,
+        runs_count=2,
+        spacing=8,
+        controls=[
+            ft.Container(
+                width=50, height=50, bgcolor=ft.Colors.PRIMARY, border_radius=8
+            ),
+            ft.Container(
+                width=50, height=50, bgcolor=ft.Colors.SECONDARY, border_radius=8
+            ),
+            ft.Container(
+                width=50, height=50, bgcolor=ft.Colors.TERTIARY, border_radius=8
+            ),
+            ft.Container(
+                width=50, height=50, bgcolor=ft.Colors.ERROR, border_radius=8
+            ),
+        ],
+    )
+    ```
     """
 
     controls: list[Control] = field(default_factory=list)

flet/controls/core/icon.py

@@ -16,10 +16,9 @@ class Icon(LayoutControl):
     Icons can be customized in color, size, and visual style using various
     parameters such as stroke weight, fill level, and shadows.
 
-    Raises:
-        ValueError: If [`fill`][(c).] is less than `0.0` or greater than `1.0`.
-        ValueError: If [`weight`][(c).] is less than or equal to `0.0`.
-        ValueError: If [`optical_size`][(c).] is less than or equal to `0.0`.
+    ```python
+    ft.Icon(ft.Icons.FAVORITE, color=ft.Colors.PRIMARY, size=40)
+    ```
     """
 
     icon: IconData
@@ -65,6 +64,9 @@ class Icon(LayoutControl):
 
     This feature requires the icon's font to support fill variation.
     It can be used to indicate state transitions or selection visually.
+
+    Raises:
+        ValueError: If [`fill`][(c).] is less than `0.0` or greater than `1.0`.
     """
 
     apply_text_scaling: Optional[bool] = None
@@ -90,6 +92,9 @@ class Icon(LayoutControl):
 
     This requires the icon font to support weight variation.
     Must be greater than `0`.
+
+    Raises:
+        ValueError: If [`weight`][(c).] is less than or equal to `0.0`.
     """
 
     optical_size: Optional[Number] = None
@@ -98,6 +103,9 @@ class Icon(LayoutControl):
 
     This requires the icon font to support optical sizing.
     Must be greater than `0`.
+
+    Raises:
+        ValueError: If [`optical_size`][(c).] is less than or equal to `0.0`.
     """
 
     blend_mode: Optional[BlendMode] = BlendMode.SRC_OVER

flet/controls/core/image.py

@@ -26,6 +26,15 @@ class Image(LayoutControl):
     - [`src_bytes`][(c).]
     - [`src_base64`][(c).]
     - [`src`][(c).]
+
+    ```python
+    ft.Image(
+        src="https://picsum.photos/seed/picsum/100/100",
+        width=100,
+        height=100,
+        fit=ft.BoxFit.CONTAIN,
+    )
+    ```
     """
 
     src: Optional[str] = None

flet/controls/core/interactive_viewer.py

@@ -21,19 +21,16 @@ __all__ = ["InteractiveViewer"]
 class InteractiveViewer(LayoutControl):
     """
     Allows you to pan, zoom, and rotate its [`content`][(c).].
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
-        ValueError: If [`min_scale`][(c).] is not greater than `0`.
-        ValueError: If [`max_scale`][(c).] is not greater than `0`.
-        ValueError: If [`max_scale`][(c).] is less than `min_scale`.
-        ValueError: If [`interaction_end_friction_coefficient`][(c).] is not
-            greater than `0`.
     """
 
     content: Control
     """
     The `Control` to be transformed.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     pan_enabled: bool = True
@@ -63,6 +60,10 @@ class InteractiveViewer(LayoutControl):
 
     Note:
         Must be greater than or equal to [`min_scale`][(c).].
+
+    Raises:
+        ValueError: If [`max_scale`][(c).] is not greater than `0` or is less than
+            [`min_scale`][(c).].
     """  # noqa: E501
 
     min_scale: Number = 0.8
@@ -72,6 +73,9 @@ class InteractiveViewer(LayoutControl):
     Note:
         Must be greater than `0` and less than or equal
         to [`max_scale`][(c).].
+
+    Raises:
+        ValueError: If [`min_scale`][(c).] is not greater than `0`.
     """
 
     interaction_end_friction_coefficient: Number = 0.0000135
@@ -80,6 +84,10 @@ class InteractiveViewer(LayoutControl):
 
     Note:
         Must be greater than `0`.
+
+    Raises:
+        ValueError: If [`interaction_end_friction_coefficient`][(c).] is not greater
+            than `0`.
     """
 
     scale_factor: Number = 200

flet/controls/core/pagelet.py

@@ -24,9 +24,6 @@ class Pagelet(LayoutControl, AdaptiveControl):
     Use it for projects that require a "page within a page" layouts with its own
     [`AppBar`][flet.], [`BottomAppBar`][flet.], [`NavigationDrawer`][flet.],
     such as demos and galleries.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
@@ -35,6 +32,9 @@ class Pagelet(LayoutControl, AdaptiveControl):
 
     The control in the content of the Pagelet is positioned at the top-left of the
     available space between the app bar and the bottom of the Pagelet.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     appbar: Optional[Union[AppBar, CupertinoAppBar]] = None

flet/controls/core/reorderable_draggable.py

@@ -11,9 +11,6 @@ class ReorderableDraggable(LayoutControl, AdaptiveControl):
 
     It creates a listener for a drag immediately following a pointer down
     event over the given [`content`][(c).] control.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     index: int
@@ -25,6 +22,11 @@ class ReorderableDraggable(LayoutControl, AdaptiveControl):
     """
     The control for which the application would like to respond to a tap and
     drag gesture by starting a reordering drag on a reorderable list.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     def before_update(self):

flet/controls/core/safe_area.py

@@ -21,14 +21,16 @@ class SafeArea(LayoutControl, AdaptiveControl):
 
     When a [`minimum_padding`][(c).] is specified, the greater of the minimum padding
     or the safe area padding will be applied.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
     """
     The control to display.
+
+    Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     avoid_intrusions_left: bool = True

flet/controls/core/text.py

@@ -178,6 +178,10 @@ class Text(LayoutControl):
 
     It consists of two sources combined to produce the final text:
     [`value`][(c).] and [`spans`][(c).].
+
+    ```python
+    ft.Text("Hello from Flet!", size=24, weight=ft.FontWeight.W_600)
+    ```
     """
 
     value: str = ""

flet/controls/core/text_span.py

@@ -18,9 +18,6 @@ class TextSpan(Control):
 
     For the object to be useful, at least one of [`text`][(c).] or
     [`spans`][(c).] should be set.
-
-    Raises:
-        ValueError: If [`semantics_label`][(c).] is set when [`text`][(c).] is `None`.
     """
 
     text: Optional[str] = None
@@ -60,6 +57,9 @@ class TextSpan(Control):
 
     If present, the semantics of this control will contain this value instead of the
     actual text.
+
+    Raises:
+        ValueError: If [`semantics_label`][(c).] is set when [`text`][(c).] is `None`.
     """
 
     spell_out: Optional[bool] = None

flet/controls/core/window_drag_area.py

@@ -13,9 +13,6 @@ class WindowDragArea(LayoutControl):
     """
     It mimics the behavior (drag, move, maximize, restore) of a native OS window
     title bar on the [`content`][(c).] control.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
     """
 
     content: Control
@@ -23,6 +20,9 @@ class WindowDragArea(LayoutControl):
     The content of this drag area.
 
     Must be visible.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     maximizable: bool = True

flet/controls/cupertino/cupertino_action_sheet.py

@@ -15,10 +15,6 @@ class CupertinoActionSheet(LayoutControl):
 
     Action sheets are generally used to give the user a choice between
     two or more choices for the current context.
-
-    Raises:
-        ValueError: If none of [`actions`][(c).], [`title`][(c).], [`message`][(c).],
-            or [`cancel`][(c).] are provided.
     """
 
     title: Optional[StrOrControl] = None
@@ -41,6 +37,10 @@ class CupertinoActionSheet(LayoutControl):
     A list of action buttons to be shown in the sheet.
 
     These actions are typically [`CupertinoActionSheetAction`][flet.]s.
+
+    Raises:
+        ValueError: If none of [`actions`][(c).], [`title`][(c).], [`message`][(c).],
+            or [`cancel`][(c).] are provided.
     """
 
     cancel: Optional[Control] = None

flet/controls/cupertino/cupertino_action_sheet_action.py

@@ -12,14 +12,14 @@ __all__ = ["CupertinoActionSheetAction"]
 class CupertinoActionSheetAction(LayoutControl):
     """
     An action button typically used in a CupertinoActionSheet.
-
-    Raises:
-        ValueError: If [`content`][(c).] is neither a string nor a visible Control.
     """
 
     content: StrOrControl
     """
     The child control to be shown in this action button.
+
+    Raises:
+        ValueError: If [`content`][(c).] is neither a string nor a visible Control.
     """
 
     default: bool = False

flet/controls/cupertino/cupertino_activity_indicator.py

@@ -11,9 +11,6 @@ __all__ = ["CupertinoActivityIndicator"]
 class CupertinoActivityIndicator(LayoutControl):
     """
     An iOS-style activity indicator that spins clockwise.
-
-    Raises:
-        ValueError: If [`radius`][(c).] is not strictly greater than `0`.
     """
 
     radius: Number = 10
@@ -22,6 +19,9 @@ class CupertinoActivityIndicator(LayoutControl):
 
     Note:
         Must be strictly greater than `0`.
+
+    Raises:
+        ValueError: If [`radius`][(c).] is not strictly greater than `0`.
     """
 
     color: Optional[ColorValue] = None

flet/controls/cupertino/cupertino_button.py

@@ -32,9 +32,9 @@ class CupertinoButton(LayoutControl):
     """
     An iOS-style button.
 
-    Raises:
-        ValueError: If [`opacity_on_click`][(c).] is not between `0.0`
-            and `1.0` inclusive.
+    ```python
+    ft.CupertinoButton("Tap me")
+    ```
     """
 
     content: Optional[StrOrControl] = None
@@ -72,6 +72,10 @@ class CupertinoButton(LayoutControl):
     Defines the opacity of the button when it is clicked.
 
     When not pressed, the button has an opacity of `1.0`.
+
+    Raises:
+        ValueError: If [`opacity_on_click`][(c).] is not between `0.0`
+            and `1.0` inclusive.
     """
 
     min_size: Optional[Size] = None

flet/controls/cupertino/cupertino_checkbox.py

@@ -23,6 +23,17 @@ class CupertinoCheckbox(LayoutControl):
 
     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.Column(
+        intrinsic_width=True,
+        controls=[
+            ft.CupertinoCheckbox(),
+            ft.CupertinoCheckbox(label="Checked", value=True),
+            ft.CupertinoCheckbox(label="Disabled", disabled=True),
+        ],
+    )
+    ```
     """
 
     label: Optional[str] = None

flet/controls/cupertino/cupertino_context_menu.py

@@ -9,10 +9,6 @@ __all__ = ["CupertinoContextMenu"]
 class CupertinoContextMenu(AdaptiveControl):
     """
     A full-screen modal route that opens up when the [`content`][(c).] is long-pressed.
-
-    Raises:
-        ValueError: If [`content`][(c).] is not visible.
-        ValueError: If [`actions`][(c).] does not contain at least one visible action.
     """
 
     content: Control
@@ -23,6 +19,9 @@ class CupertinoContextMenu(AdaptiveControl):
         When this context menu is long-pressed, the menu will open and this control
         will be moved to the new route and be expanded. This allows the content
         to resize to fit in its place in the new route, if it doesn't size itself.
+
+    Raises:
+        ValueError: If [`content`][(c).] is not visible.
     """
 
     actions: list[Control]
@@ -33,6 +32,9 @@ class CupertinoContextMenu(AdaptiveControl):
 
     Note:
         This list must have at least one visible action.
+
+    Raises:
+        ValueError: If [`actions`][(c).] does not contain at least one visible action.
     """
 
     enable_haptic_feedback: bool = True

flet/controls/cupertino/cupertino_context_menu_action.py

@@ -14,14 +14,14 @@ class CupertinoContextMenuAction(AdaptiveControl):
     A cupertino context menu action.
 
     Typically used as a child of [`CupertinoContextMenu.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