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

flet/controls/material/slider.py

@@ -36,7 +36,7 @@ class Slider(LayoutControl, AdaptiveControl):
     Raises:
         AssertionError: If [`min`][(c).] is greater than or equal to [`max`][(c).].
         AssertionError: If [`min`][(c).] is greater than or equal to [`value`][(c).].
-        AssertionError: If [`max`][(c).] is less than or equal to [`value`][(c)].
+        AssertionError: If [`max`][(c).] is less than or equal to [`value`][(c).].
     """
 
     value: Optional[Number] = None
@@ -45,7 +45,7 @@ class Slider(LayoutControl, AdaptiveControl):
 
     The slider's thumb is drawn at a position that corresponds to this value.
 
-    Defaults to value of [`min`][flet.Slider.min].
+    Defaults to value of [`min`][(c).].
     """
 
     label: Optional[str] = None
@@ -65,8 +65,8 @@ class Slider(LayoutControl, AdaptiveControl):
     The minimum value the user can select.
 
     Note:
-        - Must be less than or equal to [`max`][flet.Slider.max].
-        - If the [`max`][flet.Slider.max] is equal to the `min`, then this slider
+        - Must be less than or equal to [`max`][(c).].
+        - If the [`max`][(c).] is equal to the `min`, then this slider
             is disabled.
     """
 
@@ -75,8 +75,8 @@ class Slider(LayoutControl, AdaptiveControl):
     The maximum value the user can select.
 
     Note:
-        - Must be greater than or equal to [`min`][flet.Slider.min].
-        - If the [`min`][flet.Slider.min] is equal to the `max`, then this slider
+        - Must be greater than or equal to [`min`][(c).].
+        - If the [`min`][(c).] is equal to the `max`, then this slider
             is disabled.
     """
 
@@ -84,15 +84,15 @@ class Slider(LayoutControl, AdaptiveControl):
     """
     The number of discrete divisions.
 
-    Typically used with [`label`][flet.Slider.label] to show the current discrete value.
+    Typically used with [`label`][(c).] to show the current discrete value.
 
     If `None`, this slider is continuous.
     """
 
     round: int = 0
     """
-    The number of decimals displayed on the [`label`][flet.Slider.label]
-    containing [`value`][flet.Slider.value].
+    The number of decimals displayed on the [`label`][(c).]
+    containing [`value`][(c).].
 
     Defaults to `0`, which displays value rounded to the nearest integer.
     """
@@ -131,24 +131,24 @@ class Slider(LayoutControl, AdaptiveControl):
     """
     The allowed way for the user to interact with this slider.
 
-    If `None`, [`SliderTheme.interaction`][flet.SliderTheme.interaction] is used.
+    If `None`, [`SliderTheme.interaction`][flet.] is used.
     If that's is also `None`, defaults to
-    [`SliderInteraction.TAP_AND_SLIDE`][flet.SliderInteraction.TAP_AND_SLIDE].
+    [`SliderInteraction.TAP_AND_SLIDE`][flet.].
     """
 
     secondary_active_color: Optional[ColorValue] = None
     """
     The color to use for the portion of
     the slider track between the thumb and
-    the [`secondary_track_value`][flet.Slider.secondary_track_value].
+    the [`secondary_track_value`][(c).].
     """
 
     overlay_color: Optional[ControlStateValue[ColorValue]] = None
     """
     The highlight color that's typically
     used to indicate that the range slider thumb is in
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED] or
-    [`ControlState.DRAGGED`][flet.ControlState.DRAGGED] states.
+    [`ControlState.HOVERED`][flet.] or
+    [`ControlState.DRAGGED`][flet.] states.
     """
 
     secondary_track_value: Optional[Number] = None
@@ -182,10 +182,10 @@ class Slider(LayoutControl, AdaptiveControl):
     When `True`, the Slider will use the 2023 Material Design 3 appearance.
 
     If not set, then the
-    [`SliderTheme.year_2023`][flet.SliderTheme.year_2023] will be
+    [`SliderTheme.year_2023`][flet.] will be
     used, which is `False` by default.
 
-    If [`Theme.use_material3`][flet.Theme.use_material3] is `False`,
+    If [`Theme.use_material3`][flet.] is `False`,
     then this property is ignored.
     """
 

flet/controls/material/snack_bar.py

@@ -17,7 +17,7 @@ from flet.controls.types import (
     StrOrControl,
 )
 
-__all__ = ["SnackBar", "SnackBarBehavior", "DismissDirection", "SnackBarAction"]
+__all__ = ["DismissDirection", "SnackBar", "SnackBarAction", "SnackBarBehavior"]
 
 
 class SnackBarBehavior(Enum):
@@ -38,14 +38,15 @@ class DismissDirection(Enum):
 @control("SnackBar")
 class SnackBarAction(Control):
     """
-    A button that can be used as an action in a [`SnackBar`][flet.SnackBar].
+    A button that can be used as an action in a [`SnackBar`][flet.].
 
-    An action button for a [`SnackBar`][flet.SnackBar].
+    An action button for a [`SnackBar`][flet.].
 
     Note:
         - Snack bar actions are always enabled. Instead of disabling a snack bar
             action, avoid including it in the snack bar in the first place.
-        -  Snack bar actions can will only respond to first click. Subsequent clicks/presses are ignored.
+        -  Snack bar actions can will only respond to first click.
+            Subsequent clicks/presses are ignored.
     """
 
     label: str
@@ -56,8 +57,8 @@ class SnackBarAction(Control):
     text_color: Optional[ColorValue] = None
     """
     The button label color.
-    
-    If `None`, [`SnackBarTheme.action_text_color`][flet.SnackBarTheme.action_text_color] is used.
+
+    If `None`, [`SnackBarTheme.action_text_color`][flet.] is used.
     """
 
     disabled_text_color: Optional[ColorValue] = None
@@ -69,8 +70,8 @@ class SnackBarAction(Control):
     bgcolor: Optional[ColorValue] = None
     """
     The button background fill color.
-    
-    If `None`, [`SnackBarTheme.action_bgcolor`][flet.SnackBarTheme.action_bgcolor] is used.
+
+    If `None`, [`SnackBarTheme.action_bgcolor`][flet.] is used.
     """
 
     disabled_bgcolor: Optional[ColorValue] = None
@@ -78,7 +79,7 @@ class SnackBarAction(Control):
     The button disabled background color.
     This color is shown after the action is dismissed.
 
-    If `None`, [`SnackBarTheme.disabled_action_bgcolor`][flet.SnackBarTheme.disabled_action_bgcolor] is used.
+    If `None`, [`SnackBarTheme.disabled_action_bgcolor`][flet.] is used.
     """
 
     on_click: Optional[ControlEventHandler["SnackBarAction"]] = None
@@ -98,7 +99,7 @@ class SnackBar(DialogControl):
     """
     The primary content of the snack bar.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     behavior: Optional[SnackBarBehavior] = None
@@ -106,26 +107,26 @@ class SnackBar(DialogControl):
     This defines the behavior and location of the snack bar.
 
     Defines where a SnackBar should appear within a page and how its location
-    should be adjusted when the page also includes a [`FloatingActionButton`][flet.FloatingActionButton] or a
-    [`NavigationBar`][flet.NavigationBar].
+    should be adjusted when the page also includes a [`FloatingActionButton`][flet.]
+    or a [`NavigationBar`][flet.].
 
-    If `None`, [`SnackBarTheme.behavior`][flet.SnackBarTheme.behavior] is used.
-    If that's is also `None`, defaults to [`SnackBarBehavior.FIXED`][flet.SnackBarBehavior.FIXED].
+    If `None`, [`SnackBarTheme.behavior`][flet.] is used.
+    If that's is also `None`, defaults to [`SnackBarBehavior.FIXED`][flet.].
 
     Note:
-        - If [`behavior`][flet.SnackBar.behavior] is [`SnackBarBehavior.FLOATING`][flet.SnackBarBehavior.FLOATING], 
-          the length of the bar is defined by either [`width`][flet.SnackBar.width] and 
-          [`margin`][flet.SnackBar.margin], and if both are specified, `width` takes precedence over `margin`.
-        - [`width`][flet.SnackBar.width] and [`margin`][flet.SnackBar.margin] 
-          are ignored if `behavior!=SnackBarBehavior.FLOATING`.
+        - If [`behavior`][(c).] is [`SnackBarBehavior.FLOATING`][flet.], the length of
+            the bar is defined by either [`width`][(c).] and [`margin`][(c).], and if
+            both are specified, `width` takes precedence over `margin`.
+        - [`width`][(c).] and [`margin`][(c).] are ignored if [`behavior`][(c).]
+            is not [`SnackBarBehavior.FLOATING`][flet.].
     """
 
     dismiss_direction: Optional[DismissDirection] = None
     """
     The direction in which the SnackBar can be dismissed.
 
-    If `None`, [`SnackBarTheme.dismiss_direction`][flet.SnackBarTheme.dismiss_direction] is used.
-    If that's is also `None`, defaults to [`DismissDirection.DOWN`][flet.DismissDirection.DOWN].
+    If `None`, [`SnackBarTheme.dismiss_direction`][flet.] is used.
+    If that's is also `None`, defaults to [`DismissDirection.DOWN`][flet.].
     """
 
     show_close_icon: bool = False
@@ -147,7 +148,7 @@ class SnackBar(DialogControl):
 
     close_icon_color: Optional[ColorValue] = None
     """
-    The color of the close icon, if [`show_close_icon`][flet.SnackBar.show_close_icon] is `True`.
+    The color of the close icon, if [`show_close_icon`][(c).] is `True`.
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -181,7 +182,7 @@ class SnackBar(DialogControl):
     available space.
 
     Note:
-        Has effect only when [`behavior`][flet.SnackBar.behavior] is [`SnackBarBehavior.FLOATING`][flet.SnackBarBehavior.FLOATING]. 
+        Has effect only when [`behavior`][(c).] is [`SnackBarBehavior.FLOATING`][flet.].
         It can not be used if `margin` is specified.
     """
 
@@ -198,20 +199,20 @@ class SnackBar(DialogControl):
 
     clip_behavior: ClipBehavior = ClipBehavior.HARD_EDGE
     """
-    The [`content`][flet.SnackBar.content] will be clipped (or not) according to this option.
+    The [`content`][(c).] will be clipped (or not) according to this option.
     """
 
     action_overflow_threshold: Number = 0.25
     """
-    The percentage threshold for [`action`][flet.SnackBar.action]'s width before
+    The percentage threshold for [`action`][(c).]'s width before
     it overflows to a new line.
 
-    If the width of the snackbar's [`content`][flet.SnackBar.content] is greater than this percentage of the
-    width of the snackbar minus the width of its `action`, then the `action` will
-    appear below the `content`.
+    If the width of the snackbar's [`content`][(c).] is greater than this percentage
+    of the width of the snackbar minus the width of its `action`, then the `action`
+    will appear below the [`content`][(c).].
 
     At a value of `0.0`, the `action` will not overflow to a new line.
-    
+
     Note:
         Must be between `0.0` and `1.0` inclusive.
     """
@@ -235,6 +236,6 @@ class SnackBar(DialogControl):
             self.action_overflow_threshold is None
             or 0 <= self.action_overflow_threshold <= 1
         ), "action_overflow_threshold must be between 0 and 1 inclusive"
-        assert (
-            self.elevation is None or self.elevation >= 0
-        ), "elevation cannot be negative"
+        assert self.elevation is None or self.elevation >= 0, (
+            "elevation cannot be negative"
+        )

flet/controls/material/submenu_button.py

@@ -18,21 +18,21 @@ class SubmenuButton(LayoutControl):
     """
     A menu button that displays a cascading menu.
 
-    Typically used in a [`MenuBar`][flet.MenuBar] control.
+    Typically used in a [`MenuBar`][flet.] control.
     """
 
     content: Optional[StrOrControl] = None
     """
     The child control to be displayed in the middle portion of this button.
 
-    Typically this is the button's label, using a [`Text`][flet.Text] control.
+    Typically this is the button's label, using a [`Text`][flet.] control.
     """
 
     controls: list[Control] = field(default_factory=list)
     """
     A list of controls that appear in the menu when it is opened.
 
-    Typically either [`MenuItemButton`][flet.MenuItemButton] or
+    Typically either [`MenuItemButton`][flet.] or
     `SubMenuButton` controls.
 
     If this list is empty, then the button for this menu item will be disabled.
@@ -40,16 +40,16 @@ class SubmenuButton(LayoutControl):
 
     leading: Optional[Control] = None
     """
-    An optional control to display before the [`content`][flet.SubmenuButton.content].
+    An optional control to display before the [`content`][(c).].
 
-    Typically an [`Icon`][flet.Icon] control.
+    Typically an [`Icon`][flet.] control.
     """
 
     trailing: Optional[Control] = None
     """
-    An optional control to display after the [`content`][flet.SubmenuButton.content].
+    An optional control to display after the [`content`][(c).].
 
-    Typically an [`Icon`][flet.Icon] control.
+    Typically an [`Icon`][flet.] control.
     """
 
     clip_behavior: ClipBehavior = ClipBehavior.HARD_EDGE
@@ -70,8 +70,8 @@ class SubmenuButton(LayoutControl):
     alignment_offset: Optional[OffsetValue] = None
     """
     The offset of the menu relative to the alignment origin determined by
-    [`MenuStyle.alignment`][flet.MenuStyle.alignment] on the
-    [`style`][flet.SubmenuButton.style] attribute.
+    [`MenuStyle.alignment`][flet.] on the
+    [`style`][(c).] attribute.
     """
 
     on_open: Optional[ControlEventHandler["SubmenuButton"]] = None

flet/controls/material/switch.py

@@ -38,12 +38,12 @@ class Switch(LayoutControl, AdaptiveControl):
 
     label_position: LabelPosition = LabelPosition.RIGHT
     """
-    The position of the [`label`][flet.Switch.label], if provided.
+    The position of the [`label`][(c).], if provided.
     """
 
     label_text_style: Optional[TextStyle] = None
     """
-    The [`label`][flet.Switch.label]'s text style, when it is a string.
+    The [`label`][(c).]'s text style, when it is a string.
     """
 
     value: bool = False
@@ -69,7 +69,7 @@ class Switch(LayoutControl, AdaptiveControl):
     The color to use on the track when
     this switch is on.
 
-    If [`track_color`][flet.Switch.track_color] returns a non-none color in
+    If [`track_color`][(c).] returns a non-none color in
     the `ControlState.SELECTED` state, it will
     be used instead of this color.
     """
@@ -88,7 +88,7 @@ class Switch(LayoutControl, AdaptiveControl):
     Defaults to colors defined in the
     [material design specification](https://m3.material.io/components/switch/specs).
 
-    If [`thumb_color`][flet.Switch.thumb_color] returns a non-none color
+    If [`thumb_color`][(c).] returns a non-none color
     in the `ControlState.DEFAULT` state, it will be
     used instead of this color.
     """
@@ -101,7 +101,7 @@ class Switch(LayoutControl, AdaptiveControl):
     Defaults to colors defined in the
     [material design specification](https://m3.material.io/components/switch/specs).
 
-    If [`track_color`][flet.Switch.track_color] returns a non-none color
+    If [`track_color`][(c).] returns a non-none color
     in the `ControlState.DEFAULT` state, it will be
     used instead of this color.
     """
@@ -109,7 +109,7 @@ class Switch(LayoutControl, AdaptiveControl):
     thumb_color: Optional[ControlStateValue[ColorValue]] = None
     """
     The color of this switch's thumb
-    in various [`ControlState`][flet.ControlState]
+    in various [`ControlState`][flet.]
     states.
 
     The following states are supported: `ControlState.SELECTED`, `ControlState.HOVERED`,
@@ -120,7 +120,7 @@ class Switch(LayoutControl, AdaptiveControl):
     thumb_icon: Optional[ControlStateValue[IconData]] = None
     """
     The icon of this Switch's thumb in various
-    [`ControlState`][flet.ControlState] states.
+    [`ControlState`][flet.] states.
 
     The following states are supported: `ControlState.SELECTED`, `ControlState.HOVERED`,
     `ControlState.DISABLED`, `ControlState.FOCUSED` and
@@ -130,7 +130,7 @@ class Switch(LayoutControl, AdaptiveControl):
     track_color: Optional[ControlStateValue[ColorValue]] = None
     """
     The color of this switch's track
-    in various [`ControlState`][flet.ControlState]  states.
+    in various [`ControlState`][flet.]  states.
 
     The following states are supported: `ControlState.SELECTED`,
     `ControlState.HOVERED`, `ControlState.DISABLED`, `ControlState.FOCUSED` and
@@ -141,7 +141,7 @@ class Switch(LayoutControl, AdaptiveControl):
     """
     Whether an adaptive Switch should be created based on the target platform.
 
-    On iOS and macOS, a [`CupertinoSwitch`][flet.CupertinoSwitch] is created,
+    On iOS and macOS, a [`CupertinoSwitch`][flet.] is created,
     which has matching functionality and presentation as `Switch`,
     and the graphics as expected on iOS. On other platforms,
     a Material Switch is created.
@@ -165,7 +165,7 @@ class Switch(LayoutControl, AdaptiveControl):
     """
     The color for the switch's
     Material in various
-    [`ControlState`][flet.ControlState] states.
+    [`ControlState`][flet.] states.
 
     The following states are supported: `ControlState.PRESSED`,
     `ControlState.SELECTED`, `ControlState.HOVERED`, `ControlState.FOCUSED` and
@@ -175,7 +175,7 @@ class Switch(LayoutControl, AdaptiveControl):
     track_outline_color: Optional[ControlStateValue[ColorValue]] = None
     """
     The outline color of this switch's
-    track in various [`ControlState`][flet.ControlState]
+    track in various [`ControlState`][flet.]
     states.
 
     The following states are supported: `ControlState.SELECTED`, `
@@ -186,7 +186,7 @@ class Switch(LayoutControl, AdaptiveControl):
     track_outline_width: Optional[ControlStateValue[Optional[Number]]] = None
     """
     The outline width of this switch's track in all or specific
-    [`ControlState`][flet.ControlState] states.
+    [`ControlState`][flet.] states.
 
     The following states are supported: `ControlState.SELECTED`,
     `ControlState.HOVERED`, `ControlState.DISABLED`,
@@ -204,7 +204,7 @@ class Switch(LayoutControl, AdaptiveControl):
     The amount of space to surround the child inside the bounds of the Switch.
 
     Defaults to horizontal padding of 4 pixels. If
-    [`Theme.use_material3`][flet.Theme.use_material3] is false, then there is no
+    [`Theme.use_material3`][flet.] is false, then there is no
     padding by default.
     """