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

flet/controls/material/app_bar.py

@@ -20,31 +20,31 @@ class AppBar(AdaptiveControl):
     A material design app bar.
 
     Raises:
-        AssertionError: If [`elevation`][(c).] or [`elevation_on_scroll`][(c).] is negative.
-        AssertionError: If [`toolbar_opacity`][(c).] is not between `0.0` and `1.0` inclusive.
-    """  # noqa: E501
+        AssertionError: If [`elevation`][(c).] or [`elevation_on_scroll`][(c).]
+            is negative.
+        AssertionError: If [`toolbar_opacity`][(c).] is not between `0.0`
+            and `1.0` inclusive.
+    """
 
     leading: Optional[Control] = None
     """
-    A control to display before the toolbar's [`title`][flet.AppBar.title].
+    A control to display before the toolbar's [`title`][(c).].
 
-    Typically an [`Icon`][flet.Icon] or [`IconButton`][flet.IconButton] control.
+    Typically an [`Icon`][flet.] or [`IconButton`][flet.] control.
     """
 
     leading_width: Optional[Number] = None
     """
-    Defines the width of the [`leading`][flet.AppBar.leading] control.
+    Defines the width of the [`leading`][(c).] control.
     """
 
     automatically_imply_leading: bool = True
     """
-    Whether we should try to imply the [`leading`][flet.AppBar.leading] control
-    if it is `None`.
+    Whether we should try to imply the [`leading`][(c).] control if it is `None`.
 
     - If `True` and `leading` is `None`, this app bar will automatically determine
-      an appropriate leading control.
-    - If `False` and `leading` is `None`, the space is allocated to the
-      [`title`][flet.AppBar.title].
+        an appropriate leading control.
+    - If `False` and `leading` is `None`, the space is allocated to the [`title`][(c).].
     - If a `leading` control is provided, this parameter has no effect.
     """
 
@@ -52,22 +52,21 @@ class AppBar(AdaptiveControl):
     """
     The primary Control displayed in this app bar.
 
-    Typically a [`Text`][flet.Text]
+    Typically a [`Text`][flet.]
     control that contains a description of the current contents of this app.
 
     Note:
-        If [`AppBar.adaptive=True`][flet.AppBar.adaptive] and this app is opened on
-        an iOS or macOS device, this [`title`][flet.AppBar.title] control will be
-        automatically centered, independent of the value of
-        [`center_title`][flet.AppBar.center_title].
+        If [`AppBar.adaptive=True`][(c).adaptive] and this app is opened on
+        an iOS or macOS device, this [`title`][(c).] control will be
+        automatically centered, independent of the value of [`center_title`][(c).].
     """
 
     center_title: Optional[bool] = None
     """
-    Whether the [`title`][flet.AppBar.title] should be centered.
+    Whether the [`title`][(c).] should be centered.
 
-    Default value is defined by [`AppBarTheme.center_title`][flet.AppBarTheme.center_title]
-    """  # noqa: E501
+    Default value is defined by [`AppBarTheme.center_title`][flet.]
+    """
 
     toolbar_height: Optional[Number] = None
     """
@@ -76,17 +75,17 @@ class AppBar(AdaptiveControl):
 
     color: Optional[ColorValue] = None
     """
-    The default color for [`Text`][flet.Text]
-    and [`Icon`][flet.Icon] controls within this app bar.
+    The default color for [`Text`][flet.]
+    and [`Icon`][flet.] controls within this app bar.
 
-    Default color is defined by [`AppBarTheme.color`][flet.AppBarTheme.color]
+    Default color is defined by [`AppBarTheme.color`][flet.]
     """
 
     bgcolor: Optional[ColorValue] = None
     """
     The fill color to use for this app bar.
 
-    Default color is defined by [`AppBarTheme.bgcolor`][flet.AppBarTheme.bgcolor]
+    Default color is defined by [`AppBarTheme.bgcolor`][flet.]
     """
 
     elevation: Optional[Number] = None
@@ -95,7 +94,7 @@ class AppBar(AdaptiveControl):
 
     Note:
         This effect is only visible when using the Material 2 design
-        (when [`Theme.use_material3 = False`][flet.Theme.use_material3]).
+        (when [`Theme.use_material3`][flet.] is `False`).
     """
 
     elevation_on_scroll: Optional[Number] = None
@@ -107,7 +106,7 @@ class AppBar(AdaptiveControl):
     """
     The color of the shadow below this app bar.
 
-    A shadow is only visible and displayed if the [`elevation`][flet.AppBar.elevation]
+    A shadow is only visible and displayed if the [`elevation`][(c).]
     is greater than zero.
     """
 
@@ -120,9 +119,8 @@ class AppBar(AdaptiveControl):
     """
     Forces this app bar to be transparent (instead of Material's default type).
 
-    This will also remove the visual display of [`bgcolor`][flet.AppBar.bgcolor]
-    and [`elevation`][flet.AppBar.elevation], and affect
-    other characteristics of this app bar.
+    This will also remove the visual display of [`bgcolor`][(c).]
+    and [`elevation`][(c).], and affect other characteristics of this app bar.
     """
 
     secondary: bool = False
@@ -132,42 +130,41 @@ class AppBar(AdaptiveControl):
 
     title_spacing: Optional[Number] = None
     """
-    The spacing around [`title`][flet.AppBar.title] on the horizontal axis.
+    The spacing around [`title`][(c).] on the horizontal axis.
     It is applied even if there are
-    no [`leading`][flet.AppBar.leading] or [`actions`][flet.AppBar.actions] controls.
+    no [`leading`][(c).] or [`actions`][(c).] controls.
 
     Tip:
-        If you want [`title`][flet.AppBar.title] to take all the space available,
-        set this value to `0.0`.
+        If you want [`title`][(c).] to take all the space available,
+        set `title_spacing` to `0.0`.
     """
 
     exclude_header_semantics: bool = False
     """
-    Whether the [`title`][flet.AppBar.title] should be wrapped with header
-    [`Semantics`][flet.Semantics].
+    Whether the [`title`][(c).] should be wrapped with header
+    [`Semantics`][flet.].
     """
 
     actions: Optional[list[Control]] = None
     """
     A list of `Control`s to display in a row after the title control.
 
-    Typically, these controls are [`IconButton`][flet.IconButton]s
+    Typically, these controls are [`IconButton`][flet.]s
     representing common operations. For less common operations, consider using a
-    [`PopupMenuButton`][flet.PopupMenuButton] as the last
+    [`PopupMenuButton`][flet.] as the last
     action.
 
     Info:
-        If [`AppBar.adaptive=True`][flet.AppBar.adaptive] and this app is opened on an
+        If [`AppBar.adaptive`][(c).adaptive] is `True` and this app is opened on an
         iOS or macOS device, these `actions` will be automatically placed in a
-        [`Row`][flet.Row].
-        This is because [`CupertinoAppBar.trailing`][flet.CupertinoAppBar.trailing]
+        [`Row`][flet.].
+        This is because [`CupertinoAppBar.trailing`][flet.]
         (which is the counterpart property of `actions`) takes only a single `Control`.
     """
 
     actions_padding: Optional[PaddingValue] = None
     """
-    The padding between the [`actions`][flet.AppBar.actions]
-    and the end of this app bar.
+    The padding between the [`actions`][(c).] and the end of this app bar.
     """
 
     toolbar_opacity: Number = 1.0
@@ -180,14 +177,13 @@ class AppBar(AdaptiveControl):
 
     title_text_style: Optional[TextStyle] = None
     """
-    The style to be used for the [`Text`][flet.Text] controls in the
-    [`title`][flet.AppBar.title].
+    The style to be used for the [`Text`][flet.] controls in the [`title`][(c).].
     """
 
     toolbar_text_style: Optional[TextStyle] = None
     """
-    The style to be used for the [`Text`][flet.Text] controls in the
-    app bar's [`leading`][flet.AppBar.leading] and [`actions`][flet.AppBar.actions].
+    The style to be used for the [`Text`][flet.] controls in the
+    app bar's [`leading`][(c).] and [`actions`][(c).].
     """
 
     shape: Optional[OutlinedBorder] = None

flet/controls/material/auto_complete.py

@@ -6,7 +6,7 @@ from flet.controls.control import Control
 from flet.controls.control_event import Event, EventHandler
 from flet.controls.types import Number
 
-__all__ = ["AutoComplete", "AutoCompleteSuggestion", "AutoCompleteSelectEvent"]
+__all__ = ["AutoComplete", "AutoCompleteSelectEvent", "AutoCompleteSuggestion"]
 
 
 @dataclass
@@ -29,16 +29,18 @@ class AutoComplete(Control):
 
     suggestions: list[AutoCompleteSuggestion] = field(default_factory=list)
     """
-    A list of [`AutoCompleteSuggestion`][flet.AutoCompleteSuggestion]
+    A list of [`AutoCompleteSuggestion`][flet.]
     controls representing the suggestions to be displayed.
 
     Note:
-        - The internal filtration process of the suggestions (based on their `key`s) with
-          respect to the user's input is case-insensitive because the comparison is done
-          in lowercase.
-        - A valid `AutoCompleteSuggestion` must have at least a `key` or `value` specified,
-          else it will be ignored. If only `key` is provided, `value` will be set to `key`
-          as fallback and vice versa.
+        - A valid [`AutoCompleteSuggestion`][flet.] must have at least a
+            [`key`][flet.AutoCompleteSuggestion.] or
+            [`value`][flet.AutoCompleteSuggestion.] specified, else it will be
+            ignored. If only `key` is provided, `value` will be set to `key` as
+            fallback and vice versa.
+        - The internal filtration process of the suggestions (based on their `key`s)
+            with respect to the user's input is case-insensitive because the
+            comparison is done in lowercase.
     """
 
     suggestions_max_height: Number = 200

flet/controls/material/badge.py

@@ -14,93 +14,97 @@ __all__ = ["Badge", "BadgeValue"]
 class Badge(BaseControl):
     """
     Badges are used to show notifications, counts, or status information on navigation
-    items such as [`NavigationBar`][flet.NavigationBar] or
-    [`NavigationRail`][flet.NavigationRail] destinations or a button's icon.
+    items such as [`NavigationBar`][flet.] or [`NavigationRail`][flet.] destinations
+    or a button's icon.
     """
 
     label: Optional[StrOrControl] = None
     """
     The label of this badge.
 
-    Typically a 1 to 4 characters text.
+    Typically a `1` to `4` characters text.
 
     If the label is not provided, the badge is shown as a filled circle of
-    [`small_size`][flet.Badge.small_size] diameter.
+    [`small_size`][(c).] diameter.
 
-    If `label` is provided, the label is a `StadiumBorder` shaped badge with height equal
-    to [`large_size`][flet.Badge.large_size].
+    If `label` is provided, it is a [`StadiumBorder`][flet.] shaped
+    badge with height equal to [`large_size`][(c).].
     """
 
     offset: Optional[OffsetValue] = None
     """
     Combined with `alignment` to determine the location of the
-    [`label`][flet.Badge.label] relative to the content.
+    [`label`][(c).] relative to the content.
 
-    Has effect only used if [`label`][flet.Badge.label] is also provided.
+    Note:
+        Has effect only used if [`label`][(c).] is also provided.
     """
 
     alignment: Optional[Alignment] = None
     """
     Aligns the [`label][flet.Badge.label] relative to the content of the badge.
 
-    The alignment positions the label in similar way [`Container.content`][flet.Container.content] is
-    positioned using [`Container.alignment`][flet.Container.alignment],
-    except that the badge alignment is resolved as if the label was a [`large_size`][flet.Badge.large_size]
-    square and [`offset`][flet.Badge.offset] is added to the result.
+    The alignment positions the [`label`][(c).] in similar way
+    [`Container.content`][flet.] is positioned using [`Container.alignment`][flet.],
+    except that the badge alignment is resolved as if the `label` was a
+    [`large_size`][(c).] square and [`offset`][(c).] is added to the result.
 
-    Has effect only used if [`label`][flet.Badge.label] is also provided.
+    Note:
+        Has effect only used if [`label`][(c).] is also provided.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The background color of the [`label`][flet.Badge.label].
+    The background color of the [`label`][(c).].
     """
 
     label_visible: bool = True
     """
-    Whether the [`label`][flet.Badge.label] should be visible.
+    Whether the [`label`][(c).] should be visible.
 
     It can be used to create a badge only shown under certain conditions.
     """
 
     large_size: Optional[Number] = None
     """
-    The badge's label height if [`label`][flet.Badge.label] is provided.
+    The badge's label height if [`label`][(c).] is provided.
 
-    If the default value is overridden then it may be useful to also override `padding`
-    and `alignment`.
+    If the default value is overridden then it may be useful to also override
+    [`padding`][(c).] and [`alignment`][(c).].
 
-    Defaults to [`BadgeTheme.large_size`][flet.BadgeTheme.large_size], or if that is `None`,
+    Defaults to [`BadgeTheme.large_size`][flet.], or if that is `None`,
     falls back to `16`.
     """
 
     padding: Optional[PaddingValue] = None
     """
-    The padding added to the [`label`][flet.Badge.label].
+    The padding added to the [`label`][(c).].
 
-    Has effect only if `label` is not `None`.
-
-    Defaults to [`BadgeTheme.padding`][flet.BadgeTheme.padding], or if that is `None`,
+    Defaults to [`BadgeTheme.padding`][flet.], or if that is `None`,
     falls back to `4` pixels on the left and right.
+
+    Note:
+        Has effect only if [`label`][(c).] is not `None`.
     """
 
     small_size: Optional[Number] = None
     """
-    The badge's label diameter if [`label`][flet.Badge.label] is not provided.
+    The badge's label diameter if [`label`][(c).] is not provided.
 
-    Defaults to [`BadgeTheme.small_size`][flet.BadgeTheme.small_size], or if that is `None`,
+    Defaults to [`BadgeTheme.small_size`][flet.], or if that is `None`,
     falls back to `6`.
     """
 
     text_color: Optional[ColorValue] = None
     """
-    The color of the text shown in the label.
-    This color overrides the color of the [`label`][flet.Badge.label]'s `text_style`.
+    The color of the text shown in the [`label`][(c).].
+
+    It overrides the color of the [`label`][(c).]'s [`text_style`][(c).].
     """
 
     text_style: Optional[TextStyle] = None
     """
-    The text style to use for text in the [`label`][flet.Badge.label].
+    The text style to use for text in the [`label`][(c).].
     """
 
 

flet/controls/material/banner.py

@@ -38,14 +38,14 @@ class Banner(DialogControl):
     """
     The content of this banner.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     actions: list[Control]
     """
     The set of actions that are displayed at the bottom or trailing side of this banner.
 
-    Typically this is a list of [`TextButton`][flet.TextButton]
+    Typically this is a list of [`TextButton`][flet.]
     controls.
     """
 
@@ -53,20 +53,20 @@ class Banner(DialogControl):
     """
     The leading Control of this banner.
 
-    Typically an [`Icon`][flet.Icon] control.
+    Typically an [`Icon`][flet.] control.
     """
 
     leading_padding: Optional[PaddingValue] = None
     """
-    The amount of space by which to inset the [`leading`][flet.Banner.leading] control.
+    The amount of space by which to inset the [`leading`][(c).] control.
 
-    Defaults to [`BannerTheme.leading_padding`][flet.BannerTheme.leading_padding],
+    Defaults to [`BannerTheme.leading_padding`][flet.],
     or if that is `None`, falls back to `Padding.only(end=16)`.
     """
 
     content_padding: Optional[PaddingValue] = None
     """
-    The amount of space by which to inset the [`content`][flet.Banner.content].
+    The amount of space by which to inset the [`content`][(c).].
 
     If the actions are below the content, this defaults to
     `Padding.only(left=16.0, top=24.0, right=16.0, bottom=4.0)`.
@@ -77,12 +77,13 @@ class Banner(DialogControl):
 
     force_actions_below: bool = False
     """
-    An override to force the [`actions`][flet.Banner.actions] to be below the
-    [`content`][flet.Banner.content] regardless of how many there are.
+    An override to force the [`actions`][(c).] to be below the
+    [`content`][(c).] regardless of how many there are.
 
-    If this is `True`, the `actions` will be placed below the content. If this is
-    `False`, the `actions` will be placed on the trailing side of the `content` if
-    `actions` length is `1` and below the `content` if greater than `1`.
+    If this is `True`, the [`actions`][(c).] will be placed below the content.
+    If this is `False`, the [`actions`][(c).] will be placed on the trailing side
+    of the [`content`][(c).] if `actions` length is `1` and below the `content`
+    if greater than `1`.
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -112,13 +113,12 @@ class Banner(DialogControl):
 
     content_text_style: Optional[TextStyle] = None
     """
-    The style to be used for the [`Text`][flet.Text] controls in the
-    [`content`][flet.Banner.content].
+    The style to be used for the [`Text`][flet.] controls in the [`content`][(c).].
     """
 
     min_action_bar_height: Number = 52.0
     """
-    The optional minimum action bar height.
+    The minimum action bar height.
     """
 
     on_visible: Optional[ControlEventHandler["Banner"]] = None

flet/controls/material/bottom_app_bar.py

@@ -30,11 +30,10 @@ class BottomAppBar(LayoutControl):
 
     bgcolor: Optional[ColorValue] = None
     """
-    The fill color to use for this
-    app bar.
+    The fill color to use for this app bar.
 
-    Defaults to [`BottomAppBarTheme.bgcolor`][flet.BottomAppBarTheme.bgcolor], or if
-    that is `None`, falls back to [`ColorScheme.surface`][flet.ColorScheme.surface].
+    Defaults to [`BottomAppBarTheme.bgcolor`][flet.], or if
+    that is `None`, falls back to [`ColorScheme.surface`][flet.].
     """
 
     shadow_color: Optional[ColorValue] = None
@@ -46,14 +45,13 @@ class BottomAppBar(LayoutControl):
     """
     Empty space to inscribe inside a container decoration (background, border).
 
-    Defaults to [`BottomAppBarTheme.padding`][flet.BottomAppBarTheme.padding], or if
+    Defaults to [`BottomAppBarTheme.padding`][flet.], or if
     that is `None`, falls back to `Padding.symmetric(vertical=12.0, horizontal=16.0)`.
     """
 
     clip_behavior: ClipBehavior = ClipBehavior.NONE
     """
-    Defines how the [`content`][flet.BottomAppBar.content] of this app bar should be
-    clipped.
+    Defines how the [`content`][(c).] of this app bar should be clipped.
     """
 
     shape: Optional[NotchShape] = None
@@ -63,10 +61,10 @@ class BottomAppBar(LayoutControl):
 
     notch_margin: Number = 4.0
     """
-    The margin between the [`FloatingActionButton`][flet.FloatingActionButton] and this
+    The margin between the [`FloatingActionButton`][flet.] and this
     app bar's notch.
 
-    Can be visible only if `shape=None`.
+    Can be visible only if [`shape`][(c).] is `None`.
     """
 
     elevation: Optional[Number] = None

flet/controls/material/bottom_sheet.py

@@ -30,22 +30,22 @@ class BottomSheet(DialogControl):
 
     elevation: Optional[Number] = None
     """
-    Defines the size of the shadow below the bottom sheet.
+    Defines the size of the shadow below this bottom sheet.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The sheet's background color.
+    The background color of this bottom sheet.
     """
 
     dismissible: bool = True
     """
-    Specifies whether the bottom sheet will be dismissed when user taps on the scrim.
+    Specifies whether this bottom sheet will be dismissed when user taps on the scrim.
     """
 
     enable_drag: bool = False
     """
-    Specifies whether the bottom sheet can be dragged up and down and dismissed by
+    Specifies whether this bottom sheet can be dragged up and down and dismissed by
     swiping downwards.
     """
 
@@ -62,34 +62,34 @@ class BottomSheet(DialogControl):
 
     scroll_controlled: bool = False
     """
-    Specifies if the bottom sheet contains scrollable content, such as ListView or
+    Specifies if this bottom sheet contains scrollable content, such as ListView or
     GridView.
     """
 
     maintain_bottom_view_insets_padding: bool = True
     """
-    Adds a padding at the bottom to avoid obstructing bottom sheet content with
+    Adds a padding at the bottom to avoid obstructing the bottom sheet's content with
     on-screen keyboard or other system elements.
     """
 
     animation_style: Optional[AnimationStyle] = None
     """
-    The sheet's animation style.
+    The animation style of this bottom sheet.
     """
 
     size_constraints: Optional[BoxConstraints] = None
     """
-    The size constraints to apply to the bottom sheet.
+    The size constraints to apply to this bottom sheet.
     """
 
     clip_behavior: Optional[ClipBehavior] = None
     """
-    Defines how the content of the bottom sheet should be clipped.
+    Defines how the content of this bottom sheet should be clipped.
     """
 
     shape: Optional[OutlinedBorder] = None
     """
-    Defines the shape of the bottom sheet.
+    Defines the shape of this bottom sheet.
     """
 
     barrier_color: Optional[ColorValue] = None

flet/controls/material/button.py

@@ -22,31 +22,9 @@ __all__ = ["Button"]
 @control("Button")
 class Button(LayoutControl, AdaptiveControl):
     """
-    A customizable button control that can display text, icons, or both. It supports
-    various styles, colors, and event handlers for user interaction.
+    A customizable button control that can display text, icons, or both.
 
-    Example:
-        ```python
-        import flet as ft
-
-
-        def main(page: ft.Page):
-            def on_click(e):
-                print("Button clicked!")
-
-            page.add(
-                ft.Button(
-                    content="Click Me",
-                    icon=ft.Icons.ADD,
-                    color="white",
-                    bgcolor="blue",
-                    on_click=on_click,
-                )
-            )
-
-
-        ft.run(main)
-        ```
+    It supports various styles, colors, and event handlers for user interaction.
     """
 
     content: Optional[StrOrControl] = None

flet/controls/material/card.py

@@ -29,8 +29,8 @@ class Card(LayoutControl, AdaptiveControl):
     The Control to display inside the card.
 
     Tip:
-        To display multiple children, wrap them in a control like [`Row`][flet.Row],
-        [`Column`][flet.Column], or [`Stack`][flet.Stack], which accept
+        To display multiple children, wrap them in a control like [`Row`][flet.],
+        [`Column`][flet.], or [`Stack`][flet.], which accept
         a `controls` list.
     """
 
@@ -39,7 +39,7 @@ class Card(LayoutControl, AdaptiveControl):
     The z-coordinate at which to place this card.
     Defines the size of the shadow below the card.
 
-    Defaults to [`CardTheme.elevation`][flet.CardTheme.elevation], or if that is `None`,
+    Defaults to [`CardTheme.elevation`][flet.], or if that is `None`,
     falls back to `1.0`.
     """
 
@@ -50,11 +50,10 @@ class Card(LayoutControl, AdaptiveControl):
 
     shadow_color: Optional[ColorValue] = None
     """
-    The color to paint the shadow below this
-    card.
+    The color to paint the shadow below this card.
 
-    Defaults to [`CardTheme.shadow_color`][flet.CardTheme.shadow_color],
-    or if that is `None`, falls back to [`Theme.shadow_color`][flet.Theme.shadow_color]
+    Defaults to [`CardTheme.shadow_color`][flet.],
+    or if that is `None`, falls back to [`Theme.shadow_color`][flet.]
     (which defaults to `Colors.BLACK`).
     """
 
@@ -62,15 +61,15 @@ class Card(LayoutControl, AdaptiveControl):
     """
     The shape of this card.
 
-    Defaults to [`CardTheme.shape`][flet.CardTheme.shape], or if that is `None`,
+    Defaults to [`CardTheme.shape`][flet.], or if that is `None`,
     falls back to `RoundedRectangleBorder(radius=12.0)`.
     """
 
     clip_behavior: Optional[ClipBehavior] = None
     """
-    Defines how the [`content`][flet.Card.content] will be clipped.
+    Defines how the [`content`][(c).] will be clipped.
 
-    Defaults to [`CardTheme.clip_behavior`][flet.CardTheme.clip_behavior],
+    Defaults to [`CardTheme.clip_behavior`][flet.],
     or if that is `None`, falls back to `ClipBehavior.NONE`.
     """
 
@@ -84,7 +83,7 @@ class Card(LayoutControl, AdaptiveControl):
     show_border_on_foreground: bool = True
     """
     Whether the shape of the border should be painted in front of the
-    [`content`][flet.Card.content] or behind.
+    [`content`][(c).] or behind.
     """
 
     variant: CardVariant = CardVariant.ELEVATED