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

flet/controls/cupertino/cupertino_app_bar.py

@@ -15,19 +15,19 @@ class CupertinoAppBar(Control):
     An iOS-styled app bar.
 
     Note:
-        The alignment of the [`title`][(c).] depends on whether this app bar is [`large`][(c).] or not.
-        If it is `True`, the `title` is left-aligned and if it is `False` (the default),
-        the `title` is centered.
+        The alignment of the [`title`][(c).] depends on whether
+        this app bar is [`large`][(c).] or not.
+        If it is `True`, the [`title`][(c).] is left-aligned and if it
+        is `False` (the default), the [`title`][(c).] is centered.
     """
 
     leading: Optional[Control] = None
     """
     A control to display at the start of this app bar.
 
-    Typically the leading control is an [`Icon`][flet.Icon] or an
-    [`IconButton`][flet.IconButton].
+    Typically the leading control is an [`Icon`][flet.] or an [`IconButton`][flet.] .
 
-    If it is `None` and [`automatically_imply_leading = True`][flet.CupertinoAppBar.automatically_imply_leading],
+    If it is `None` and [`automatically_imply_leading`][(c).] is `True`,
     an appropriate button will be automatically created.
     """
 
@@ -35,7 +35,7 @@ class CupertinoAppBar(Control):
     """
     A string or a control to display in the middle of this app bar.
 
-    Typically a [`Text`][flet.Text].
+    Typically a [`Text`][flet.].
     """
 
     trailing: Optional[Control] = None
@@ -54,20 +54,21 @@ class CupertinoAppBar(Control):
 
     automatically_imply_leading: Optional[bool] = None
     """
-    Whether we should try to imply the [`leading`][flet.CupertinoAppBar.leading]
-    control if `None`.
+    Whether we should try to imply the [`leading`][(c).] control if `None`.
 
-    - If `True` and `leading` is `None`, the app bar will automatically determine an appropriate leading control.
-    - If `False` and `leading` is `None`, the space is allocated to the `title`.
-    - If a `leading` control is provided, this parameter has no effect.
+    - If `True` and [`leading`][(c).] is `None`, the app bar will automatically
+        determine an appropriate leading control.
+    - If `False` and [`leading`][(c).] is `None`,
+        the space is allocated to the [`title`][(c).].
+    - If a [`leading`][(c).] control is provided, this parameter has no effect.
     """
 
     automatically_imply_title: Optional[bool] = None
     """
     Whether we should try to imply the `title` control if `None`.
 
-    - If True and `title` is `None`, a [`Text`][flet.Text] control containing the
-      current route's title will be automatically filled in.
+    - If True and `title` is `None`, a [`Text`][flet.] control containing the
+        current route's title will be automatically filled in.
     - If the `title` is not `None`, this parameter has no effect.
     """
 
@@ -84,10 +85,10 @@ class CupertinoAppBar(Control):
     If `None`, the app bar will adopt the following defaults:
 
     - vertically, contents will be sized to the same height as the app bar itself minus
-      the status bar.
+        the status bar.
     - horizontally, padding will be `16` pixels according to iOS specifications unless
-      the leading widget is an automatically inserted back button, in which case the
-      padding will be `0`.
+        the leading widget is an automatically inserted back button, in which case the
+        padding will be `0`.
 
     Note:
         Vertical padding (`top` and `bottom`) won't change the height of this app bar.
@@ -97,8 +98,8 @@ class CupertinoAppBar(Control):
     """
     Determines whether the app bar transitions between routes.
 
-    If `True`, this app bar will animate on top of route transitions when the destination
-    route also contains a `CupertinoAppBar` or `CupertinoSliverAppBar` with
+    If `True`, this app bar will animate on top of route transitions when the
+    destination route also contains a `CupertinoAppBar` or `CupertinoSliverAppBar` with
     `transition_between_routes` set to `True`.
 
     This transition also occurs during edge back swipe gestures, mimicking native iOS
@@ -111,42 +112,41 @@ class CupertinoAppBar(Control):
 
     previous_page_title: Optional[str] = None
     """
-    Manually specify the previous route's title when automatically implying the leading back button.
+    Manually specify the previous route's title when automatically implying
+    the leading back button.
 
     Overrides the text shown with the back chevron instead of automatically showing the
-    previous route's title when [`automatically_imply_leading`][flet.CupertinoAppBar.automatically_imply_leading]
-    is `True`.
+    previous route's title when [`automatically_imply_leading`][(c).] is `True`.
 
     Note:
         Has no effect if `leading` is not `None` or if
-        [`automatically_imply_leading`][flet.CupertinoAppBar.automatically_imply_leading] is `False`.
+        [`automatically_imply_leading`][(c).] is `False`.
     """
 
     brightness: Optional[Brightness] = None
     """
-    The brightness of the specified [`bgcolor`][flet.CupertinoAppBar.bgcolor].
+    The brightness of the specified [`bgcolor`][(c).].
 
     Setting this value changes the style of the system status bar. It is typically used
-    to increase the contrast ratio of the system status bar over `bgcolor`.
+    to increase the contrast ratio of the system status bar over [`bgcolor`][(c).].
 
     If `None` (the default), its value will be inferred from the relative luminance of
-    the `bgcolor`.
+    the [`bgcolor`][(c).].
     """
 
     automatic_background_visibility: Optional[bool] = None
     """
-    Whether the navigation bar should appear transparent when content is scrolled under
-    it.
+    Whether the navigation bar should appear transparent
+    when content is scrolled under it.
 
-    If `False`, the navigation bar will display its [`bgcolor`][flet.CupertinoAppBar.bgcolor].
+    If `False`, the navigation bar will display its [`bgcolor`][(c).].
     """
 
     enable_background_filter_blur: Optional[bool] = None
     """
-    Whether to have a blur effect when a non-opaque [`bgcolor`][flet.CupertinoAppBar.bgcolor] is used.
+    Whether to have a blur effect when a non-opaque [`bgcolor`][(c).] is used.
 
-    This will only be respected when
-    [`automatic_background_visibility`][flet.CupertinoAppBar.automatic_background_visibility]
+    This will only be respected when [`automatic_background_visibility`][(c).]
     is `False` or until content scrolls under the navigation bar.
     """
 
@@ -154,6 +154,6 @@ class CupertinoAppBar(Control):
     """
     Whether to use a large app bar layout.
 
-    If `True`, the title will be left-aligned and if it is `False`, the title will be
-    centered.
+    If `True`, the [`title`][(c).] is left-aligned;
+    if `False`, the [`title`][(c).] is centered.
     """

flet/controls/cupertino/cupertino_bottom_sheet.py

@@ -12,23 +12,23 @@ __all__ = ["CupertinoBottomSheet"]
 @control("CupertinoBottomSheet")
 class CupertinoBottomSheet(DialogControl):
     """
-    A Cupertino version of modal bottom sheet.
+    A Cupertino bottom sheet.
     """
 
     content: Control
     """
-    The control to be displayed.
+    The control to be displayed in this bottom sheet.
     """
 
     modal: bool = False
     """
-    Whether this bottom sheet can be dismissed/closed by clicking the area outside of
-    it.
+    Whether this bottom sheet can be dismissed/closed by
+    clicking the area outside of it.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The sheet's background color.
+    The background color of this bottom sheet.
     """
 
     height: Optional[Number] = None

flet/controls/cupertino/cupertino_button.py

@@ -49,7 +49,7 @@ class CupertinoButton(LayoutControl):
 
     icon_color: Optional[ColorValue] = None
     """
-    The foreground color of the [`icon`][flet.CupertinoButton.icon].
+    The foreground color of the [`icon`][(c).].
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -110,7 +110,7 @@ class CupertinoButton(LayoutControl):
     """
     The URL to open when this button is clicked.
 
-    Additionally, if [`on_click`][flet.CupertinoButton.on_click] event callback is
+    Additionally, if [`on_click`][(c).] event callback is
     provided, it is fired after that.
     """
 
@@ -124,9 +124,9 @@ class CupertinoButton(LayoutControl):
     """
     The color to use for the focus highlight for keyboard interactions.
 
-    Defaults to a slightly transparent [`bgcolor`][flet.CupertinoButton.bgcolor].
+    Defaults to a slightly transparent [`bgcolor`][(c).].
     If `bgcolor` is `None`, defaults to a slightly transparent
-    [`CupertinoColors.ACTIVE_BLUE`][flet.CupertinoColors.ACTIVE_BLUE].
+    [`CupertinoColors.ACTIVE_BLUE`][flet.].
     'Slightly transparent' in this context means the color is used with an opacity
     of `0.80`, a brightness of `0.69` and a saturation of `0.835`.
     """

flet/controls/cupertino/cupertino_checkbox.py

@@ -19,48 +19,47 @@ __all__ = ["CupertinoCheckbox"]
 @control("CupertinoCheckbox")
 class CupertinoCheckbox(LayoutControl):
     """
-    A macOS style checkbox. Checkbox allows to select one or more items from a group,
+    A macOS style checkbox.
+
+    Checkbox allows to select one or more items from a group,
     or switch between two mutually exclusive options (checked or unchecked, on or off).
     """
 
     label: Optional[str] = None
     """
-    The clickable label to display on the right of a checkbox.
+    A clickable label to display on the right of this checkbox.
     """
 
     label_position: LabelPosition = LabelPosition.RIGHT
     """
-    Defines on which side of the checkbox the [`label`][flet.CupertinoCheckbox.label]
-    should be shown.
+    Defines on which side of this checkbox the [`label`][(c).] should be shown.
     """
 
     value: Optional[bool] = False
     """
     The value of this checkbox.
 
-    - If `True` the checkbox is checked.
-    - If `False` the checkbox is unchecked.
-    - If `None` and [`tristate`][flet.CupertinoCheckbox.tristate] is `True`
-        the checkbox is indeterminate. (displayed as a dash)
+    - If `True`, this checkbox is checked.
+    - If `False`, this checkbox is unchecked.
+    - If `None` and [`tristate`][(c).] is `True`,
+        this checkbox is indeterminate (displayed as a dash).
     """
 
     tristate: bool = False
     """
-    If `True` the checkbox's [`value`][flet.CupertinoCheckbox.value] can be `True`,
-    `False`, or `None`.
+    If `True`, this checkbox's [`value`][(c).] can be `True`, `False`, or `None`.
     """
 
     autofocus: bool = False
     """
-    Whether this control will be selected as the initial focus. If there is more than
+    Whether this checkbox will be selected as the initial focus. If there is more than
     one control on a page with autofocus set, then the first one added to the page will
     get focus.
     """
 
     check_color: Optional[ColorValue] = None
     """
-    The color to use for the check icon when
-    this checkbox is checked.
+    The color to use for the check icon when this checkbox is checked.
     """
 
     active_color: Optional[ColorValue] = CupertinoColors.ACTIVE_BLUE
@@ -68,34 +67,30 @@ class CupertinoCheckbox(LayoutControl):
     The color used to fill checkbox when it
     is checked/selected.
 
-    If [`fill_color`][flet.CupertinoCheckbox.fill_color] returns a non-null color in the
-    `ControlState.SELECTED` state, it will be used instead of this color.
-
-    Defaults to `Colors.PRIMARY`.
+    If [`fill_color`][(c).] returns a non-null color in the
+    [`ControlState.SELECTED`][flet.] state, it will be used instead of this color.
     """
 
     focus_color: Optional[ColorValue] = None
     """
-    The color used for the checkbox's border
-    shadow when it has the input focus.
+    The color used for this checkbox's border shadow when it has the input focus.
     """
 
     fill_color: Optional[ControlStateValue[ColorValue]] = None
     """
-    The color used to fill the checkbox in
-    all or specific [`ControlState`][flet.ControlState]
+    The color used to fill this checkbox in all or specific [`ControlState`][flet.]
     states.
 
-    Supported states: [`ControlState.SELECTED`][flet.ControlState.SELECTED],
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED],
-    [`ControlState.DISABLED`][flet.ControlState.DISABLED],
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
+    [`active_color`][(c).] is used as fallback color when
+    the checkbox is in the [`SELECTED`][flet.ControlState.] state,
+    [`CupertinoColors.WHITE`][flet.] at `50%` opacity is used as fallback color
+    when this checkbox is in the [`DISABLED`][flet.ControlState.] state, and
+    [`CupertinoColors.WHITE`][flet.] otherwise.
 
-    [`active_color`][flet.CupertinoCheckbox.active_color] is used as fallback color when
-    the checkbox is in the `SELECTED` state, `CupertinoColors.WHITE` at 50% opacity
-    is used as fallback color when this checkbox is in the `DISABLED` state,
-    and `CupertinoColors.WHITE` otherwise.
+    Note:
+        Supported states: [`ControlState.SELECTED`][flet.],
+        [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+        [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     shape: Optional[OutlinedBorder] = None
@@ -112,7 +107,7 @@ class CupertinoCheckbox(LayoutControl):
 
     semantics_label: Optional[str] = None
     """
-    The semantic label for the checkbox that will be announced by screen readers.
+    The semantic label for this checkbox that will be announced by screen readers.
 
     This is announced by assistive technologies (e.g TalkBack/VoiceOver) and not shown
     on the UI.
@@ -121,15 +116,13 @@ class CupertinoCheckbox(LayoutControl):
     border_side: Optional[ControlStateValue[BorderSide]] = None
     """
     Defines the checkbox's border sides in all or specific
-    [`ControlState`][flet.ControlState] states.
-
-    Supported states: [`ControlState.SELECTED`][flet.ControlState.SELECTED],
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED],
-    [`ControlState.DISABLED`][flet.ControlState.DISABLED],
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED],
-    [`ControlState.PRESSED`][flet.ControlState.PRESSED],
-    [`ControlState.ERROR`][flet.ControlState.ERROR],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
+    [`ControlState`][flet.] states.
+
+    Note:
+        Supported states: [`ControlState.SELECTED`][flet.],
+        [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+        [`ControlState.FOCUSED`][flet.], [`ControlState.PRESSED`][flet.],
+        [`ControlState.ERROR`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     on_change: Optional[ControlEventHandler["CupertinoCheckbox"]] = None

flet/controls/cupertino/cupertino_context_menu.py

@@ -13,18 +13,19 @@ class CupertinoContextMenu(AdaptiveControl):
 
     content: Control
     """
-    The child control to be shown.
+    The content of this context menu.
 
-    When the `CupertinoContextMenu` is long-pressed, the menu will open and this control
-    will be moved to the new route and be expanded. This allows the child to resize to
-    fit in its place in the new route, if it doesn't size itself.
+    Info:
+        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.
     """
 
     actions: list[Control]
     """
     A list of action buttons to be shown in the menu.
 
-    Typically [`CupertinoContextMenuAction`][flet.CupertinoContextMenuAction]s.
+    Typically [`CupertinoContextMenuAction`][flet.]s.
 
     Note:
         This list must have at least one visible action.
@@ -32,7 +33,7 @@ class CupertinoContextMenu(AdaptiveControl):
 
     enable_haptic_feedback: bool = True
     """
-    Whether a click on the `actions` should produce haptic feedback.
+    Whether a click on the [`actions`][(c).] should produce haptic feedback.
     """
 
     def before_update(self):

flet/controls/cupertino/cupertino_context_menu_action.py

@@ -13,8 +13,7 @@ class CupertinoContextMenuAction(AdaptiveControl):
     """
     A cupertino context menu action.
 
-    Typically used as a child of
-    [`CupertinoContextMenu.actions`][flet.CupertinoContextMenu.actions].
+    Typically used as a child of [`CupertinoContextMenu.actions`][flet.].
 
     Raises:
         AssertionError: If [`content`][(c).] is neither a string nor a visible Control.
@@ -37,8 +36,7 @@ class CupertinoContextMenuAction(AdaptiveControl):
 
     trailing_icon: Optional[IconData] = None
     """
-    An optional icon to display at the right of the
-    [`content`][flet.CupertinoContextMenuAction.content] control.
+    An icon to display at the right of the [`content`][(c).] control.
     """
 
     on_click: Optional[ControlEventHandler["CupertinoContextMenuAction"]] = None

flet/controls/cupertino/cupertino_date_picker.py

@@ -38,9 +38,11 @@ class CupertinoDatePicker(LayoutControl):
 
     value: DateTimeValue = field(default_factory=lambda: datetime.now())
     """
-    The initial date and/or time of the picker. It must conform to the intervals
-    set in `first_date`, `last_date`, `min_year`, and `max_year` else an error
-    will be `ValueError` will be raised.
+    The initial date and/or time of the picker.
+
+    It must conform to the intervals set in [`first_date`][(c).], [`last_date`][(c).],
+    [`minimum_year`][(c).], and [`maximum_year`][(c).],
+    else a `ValueError` will be raised.
 
     Defaults to the present date and time.
     """
@@ -49,45 +51,43 @@ class CupertinoDatePicker(LayoutControl):
     """
     The earliest allowable date that the user can select.
 
-    Defaults to `None` - no limit.
-
-    When not `None` (no limit), one can still scroll the picker to dates earlier than
-    `first_date`, with the exception that the
-    [`on_change`][flet.CupertinoDatePicker.on_change] will not be called.
-    Once let go, the picker will scroll back to `first_date`.
+    - If set to `None` (the default), there is no lower date limit.
+    - When not `None`, one can still scroll the picker to dates earlier than
+        `first_date`, with the exception that the [`on_change`][(c).] will not be
+        called. Once let go, the picker will scroll back to `first_date`.
 
-    In `CupertinoDatePickerMode.TIME` mode, a time becomes unselectable if the
-    datetime produced by combining that particular time and the date part of
-    initialDateTime is earlier than `last_date`. So typically `first_date` needs
-    to be set to a datetime that is on the same date as initialDateTime.
+    Note:
+        In [`CupertinoDatePickerMode.TIME`][flet.] mode, a time becomes unselectable
+        if the datetime produced by combining that particular time and the date part of
+        [`value`][(c).] is earlier than `last_date`. So typically, `first_date` needs
+        to be set to a datetime that is on the same date as [`value`][(c).].
     """
 
     last_date: Optional[DateTimeValue] = None
     """
     The latest allowable date that the user can select.
 
-    When not `None`, one can still scroll the picker to dates later than
-    `last_date`, with the exception that the `on_change` will not be called.
-    Once let go, the picker will scroll back to `last_date`.
+    - If set to `None` (the default), there is no upper date limit.
+    - When not `None`, one can still scroll the picker to dates later than
+        `last_date`, with the exception that the [`on_change`][(c).] will not be called.
+        Once let go, the picker will scroll back to `last_date`.
 
-    In [`CupertinoDatePickerMode.TIME`][flet.CupertinoDatePickerMode.TIME] mode,
-    a time becomes unselectable if the
-    datetime produced by combining that particular time and the date part of
-    initialDateTime is later than `last_date`. So typically `last_date` needs to
-    be set to a datetime that is on the same date as initialDateTime.
-
-    Defaults to `None` - no limit.
+    Note:
+        In [`CupertinoDatePickerMode.TIME`][flet.] mode, a time becomes unselectable
+        if the datetime produced by combining that particular time and the date part
+        of [`value`][(c).] is later than `last_date`. So typically, `last_date` needs
+        to be set to a datetime that is on the same date as [`value`][(c).].
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The background color of the date picker.
+    The background color of this date picker.
     """
 
     minute_interval: int = 1
     """
     The granularity of the minutes spinner, if it is shown in the current
-    [`date_picker_mode`][flet.CupertinoDatePicker.date_picker_mode].
+    [`date_picker_mode`][(c).].
 
     Note:
         Must be an integer factor of `60`.
@@ -96,13 +96,13 @@ class CupertinoDatePicker(LayoutControl):
     minimum_year: int = 1
     """
     Minimum year to which the picker can be scrolled when in
-    [`CupertinoDatePickerMode.DATE`][flet.CupertinoDatePickerMode.DATE] mode.
+    [`CupertinoDatePickerMode.DATE`][flet.] mode.
     """
 
     maximum_year: Optional[int] = None
     """
     Maximum year to which the picker can be scrolled when in
-    [`CupertinoDatePickerMode.DATE`][flet.CupertinoDatePickerMode.DATE] mode.
+    [`CupertinoDatePickerMode.DATE`][flet.] mode.
 
     Defaults to `None` - no limit.
     """
@@ -135,21 +135,19 @@ class CupertinoDatePicker(LayoutControl):
 
     Note:
         The final order in which the columns are displayed is also influenced by
-        the [`date_picker_mode`][flet.CupertinoDatePicker.date_picker_mode].
-        For example,if `date_picker_mode` is
-        [`CupertinoDatePickerMode.MONTH_YEAR`][flet.CupertinoDatePickerMode.MONTH_YEAR]
-        both [`CupertinoDatePickerDateOrder.DAY_MONTH_YEAR`][flet.CupertinoDatePickerDateOrder.DAY_MONTH_YEAR] and
-        [`CupertinoDatePickerDateOrder.MONTH_DAY_YEAR`][flet.CupertinoDatePickerDateOrder.MONTH_DAY_YEAR] will result in the month|year order.
-    """  # noqa: E501
+        the [`date_picker_mode`][(c).]. For example, if `date_picker_mode` is
+        [`CupertinoDatePickerMode.MONTH_YEAR`][flet.]
+        both [`CupertinoDatePickerDateOrder.DAY_MONTH_YEAR`][flet.] and
+        [`CupertinoDatePickerDateOrder.MONTH_DAY_YEAR`][flet.] will result
+        in the `month|year` order.
+    """
 
     on_change: Optional[ControlEventHandler["CupertinoDatePicker"]] = None
     """
     Called when the selected date and/or time changes.
 
-    Will not fire if the new
-    selected value is not valid, or is not in the range of
-    [`first_date`][flet.CupertinoDatePicker.first_date] and
-    [`last_date`][flet.CupertinoDatePicker.last_date].
+    Will not be called if the new selected value is not valid,
+    or is not in the range of [`first_date`][(c).] and [`last_date`][(c).].
     """
 
     def before_update(self):

flet/controls/cupertino/cupertino_dialog_action.py

@@ -14,7 +14,7 @@ class CupertinoDialogAction(Control):
     """
     A dialog action button.
 
-    Typically used as a child of [`CupertinoAlertDialog.actions`][flet.CupertinoAlertDialog.actions].
+    Typically used as a child of [`CupertinoAlertDialog.actions`][flet.].
 
     Raises:
         AssertionError: If [`content`][(c).] is neither a string nor a visible Control.
@@ -27,29 +27,32 @@ class CupertinoDialogAction(Control):
 
     default: bool = False
     """
-    Whether this action is a default action. In this case, the button will have bold text.
+    Whether this action is a default action.
+    In this case, the button will have bold text.
 
     Info:
-        More than one action can have
-        this property set to `True` in [`CupertinoAlertDialog`][flet.CupertinoAlertDialog].
+        Multiple actions can have this property set to `True`
+        in a [`CupertinoAlertDialog`][flet.].
     """
 
     destructive: bool = False
     """
-    If set to True, the button's text color will be red. Use it for actions that
-    destroy objects, such as an delete that deletes an email etc.
+    If set to `True`, this button's text color will be red.
+
+    Typically used for actions that destroy objects,
+    such as an delete that deletes an email etc.
     """
 
     text_style: Optional[TextStyle] = None
     """
-    The text style to use for text in the button.
+    The text style to use for text in this button.
 
-    Can be useful when [`content`][flet.CupertinoDialogAction.content] is a string.
+    Can be useful when [`content`][(c).] is a string.
     """
 
     on_click: Optional[ControlEventHandler["CupertinoDialogAction"]] = None
     """
-    Called when a user clicks the button.
+    Called when a user clicks this button.
     """
 
     def before_update(self):