flet 0.84.0.dev0__tar.gz → 0.85.0.dev0__tar.gz

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet
-Version: 0.84.0.dev0
+Version: 0.85.0.dev0
 Summary: Flet for Python - easily build interactive multi-platform apps in Python
 Author-email: "Appveyor Systems Inc." <hello@flet.dev>
 License-Expression: Apache-2.0
@@ -9,23 +9,23 @@ Project-URL: Repository, https://github.com/flet-dev/flet
 Project-URL: Documentation, https://flet.dev/docs/
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "cli"
-Requires-Dist: flet-web==0.84.0.dev0; extra == "web"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "cli"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "web"
 Requires-Dist: oauthlib>=3.2.2; platform_system != "Pyodide"
 Requires-Dist: httpx>=0.28.1; platform_system != "Pyodide"
 Requires-Dist: repath>=0.9.0
 Requires-Dist: msgpack>=1.1.0
 Requires-Dist: typing-extensions; python_version < "3.11"
 Provides-Extra: all
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "all"
-Requires-Dist: flet-web==0.84.0.dev0; extra == "all"
-Requires-Dist: flet-desktop==0.84.0.dev0; extra == "all"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "all"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "all"
+Requires-Dist: flet-desktop==0.85.0.dev0; extra == "all"
 Provides-Extra: cli
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "cli"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "cli"
 Provides-Extra: desktop
-Requires-Dist: flet-desktop==0.84.0.dev0; extra == "desktop"
+Requires-Dist: flet-desktop==0.85.0.dev0; extra == "desktop"
 Provides-Extra: web
-Requires-Dist: flet-web==0.84.0.dev0; extra == "web"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "web"
 
 <p align="center">
   <a href="https://flet.dev"><img src="https://raw.githubusercontent.com/flet-dev/flet/refs/heads/main/media/logo/flet-logo.svg" height="150" alt="Flet logo"></a>

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
 name = "flet"
-version = "0.84.0.dev0"
+version = "0.85.0.dev0"
 description = "Flet for Python - easily build interactive multi-platform apps in Python"
 authors = [{name = "Appveyor Systems Inc.", email = "hello@flet.dev"}]
 license = "Apache-2.0"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "flet-cli==0.84.0.dev0; extra == 'cli'",
-    "flet-web==0.84.0.dev0; extra == 'web'",
+    "flet-cli==0.85.0.dev0; extra == 'cli'",
+    "flet-web==0.85.0.dev0; extra == 'web'",
     "oauthlib >=3.2.2; platform_system != 'Pyodide'",
     "httpx >=0.28.1; platform_system != 'Pyodide'",
     "repath >=0.9.0",
@@ -23,15 +23,15 @@ Documentation = "https://flet.dev/docs/"
 
 [project.optional-dependencies]
 all = [
-    "flet-cli==0.84.0.dev0",
-    "flet-web==0.84.0.dev0",
-    "flet-desktop==0.84.0.dev0",
+    "flet-cli==0.85.0.dev0",
+    "flet-web==0.85.0.dev0",
+    "flet-desktop==0.85.0.dev0",
 ]
-cli = ["flet-cli==0.84.0.dev0"]
+cli = ["flet-cli==0.85.0.dev0"]
 desktop = [
-    "flet-desktop==0.84.0.dev0",
+    "flet-desktop==0.85.0.dev0",
 ]
-web = ["flet-web==0.84.0.dev0"]
+web = ["flet-web==0.85.0.dev0"]
 
 [project.scripts]
 flet = "flet.cli:main"

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet/__init__.py

@@ -5,6 +5,7 @@ from flet.components.component import Component
 from flet.components.component_decorator import component
 from flet.components.hooks.use_callback import use_callback
 from flet.components.hooks.use_context import create_context, use_context
+from flet.components.hooks.use_dialog import use_dialog
 from flet.components.hooks.use_effect import (
     on_mounted,
     on_unmounted,
@@ -1111,6 +1112,7 @@ __all__ = [
     "unwrap_component",
     "use_callback",
     "use_context",
+    "use_dialog",
     "use_effect",
     "use_memo",
     "use_ref",

flet-0.85.0.dev0/src/flet/components/hooks/use_dialog.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+from flet.components.hooks.use_effect import use_effect
+from flet.components.hooks.use_ref import use_ref
+from flet.controls.context import context
+from flet.controls.dialog_control import DialogControl
+
+
+def use_dialog(dialog: DialogControl | None = None):
+    """
+    Portal a :class:`~flet.DialogControl` to the page's dialog overlay.
+
+    Call this hook inside a :func:`~flet.component` function on every render.
+    Pass a :class:`~flet.DialogControl` instance to show the dialog,
+    or `None` to hide/remove it. The dialog content is updated
+    reactively on each re-render.
+
+    The hook automatically sets `open=True` on the dialog when it is
+    added to the overlay and removes it when `None` is passed or the
+    component unmounts.
+
+    Args:
+        dialog: A :class:`~flet.DialogControl` to display, or `None`
+            to hide it.
+    """
+    ref = use_ref(None)
+    page = context.page
+
+    prev = ref.current
+
+    if prev is not None and prev not in page._dialogs.controls:
+        ref.current = None
+        prev = None
+
+    if dialog is not None:
+        dialog.open = True
+        page._prepare_dialog(dialog)
+        if prev is not None and prev in page._dialogs.controls:
+            # Frozen diff: compares prev and dialog field-by-field,
+            # sends only actual deltas, and transfers _i via _migrate_state
+            # so Flutter preserves widget identity (e.g. TextField cursor).
+            page.session.patch_control(control=dialog, prev_control=prev, frozen=True)
+            # Strip _frozen set by _dataclass_added during frozen diff
+            # so we can later set open=False for dismissal.
+            if hasattr(dialog, "_frozen"):
+                del dialog._frozen
+            idx = page._dialogs.controls.index(prev)
+            page._dialogs.controls[idx] = dialog
+            ref.current = dialog
+        else:
+            page._dialogs.controls.append(dialog)
+            ref.current = dialog
+            page.session.schedule_update(page._dialogs)
+    elif prev is not None and prev.open:
+        # Dismiss: patch open=False so Flutter pops the dialog route.
+        # Keep prev in _dialogs.controls and ref.current so the dialog
+        # stays alive in session.__index (WeakValueDictionary) — Flutter
+        # needs the control present to dispatch the dismiss event. The
+        # wrapped dismiss handler removes it after Flutter signals close.
+        prev.open = False
+        page.session.patch_control(prev)
+
+    def _cleanup():
+        d = ref.current
+        if d is not None:
+            ref.current = None
+            if d.open:
+                d.open = False
+                page.session.patch_control(d)
+
+    use_effect(lambda: None, dependencies=[], cleanup=_cleanup)

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet/controls/base_page.py

@@ -1,4 +1,5 @@
 import logging
+import weakref
 from dataclasses import dataclass, field
 from typing import (
     TYPE_CHECKING,
@@ -44,6 +45,9 @@ from flet.controls.types import (
 
 logger = logging.getLogger("flet")
 
+_MANAGED_DIALOG_DISMISS_ORIGINAL = "_managed_dialog_dismiss_original"
+_MANAGED_DIALOG_DISMISS_WRAPPER = "_managed_dialog_dismiss_wrapper"
+
 if TYPE_CHECKING:
     from flet.controls.theme import Theme
 
@@ -390,30 +394,8 @@ class BasePage(AdaptiveControl):
         if dialog in self._dialogs.controls:
             raise RuntimeError("Dialog is already opened")
 
-        original_on_dismiss = dialog.on_dismiss
-
-        async def wrapped_on_dismiss(*args):
-            """
-            Remove dialog from stack and forward dismiss event to original handler.
-
-            Args:
-                *args: Dismiss event arguments passed by the framework.
-            """
-
-            if dialog in self._dialogs.controls:
-                self._dialogs.controls.remove(dialog)
-                self._dialogs.update()
-            dialog.on_dismiss = original_on_dismiss
-            e = args[0]
-            if (
-                original_on_dismiss and (e.data is None or e.data)  # e.data == True for
-                # TimePicker and DatePicker if they were dismissed without
-                # changing the value
-            ):
-                await dialog._trigger_event("dismiss", e)
-
         dialog.open = True
-        dialog.on_dismiss = wrapped_on_dismiss
+        self._prepare_dialog(dialog)
 
         self._dialogs.controls.append(dialog)
         self._dialogs.update()
@@ -438,6 +420,52 @@ class BasePage(AdaptiveControl):
         dialog.update()
         return dialog
 
+    def _prepare_dialog(self, dialog: DialogControl) -> None:
+        self._set_dialog_parent(dialog)
+        self._wrap_dialog_on_dismiss(dialog)
+
+    def _set_dialog_parent(self, dialog: DialogControl) -> None:
+        dialog._parent = weakref.ref(self._dialogs)
+
+    def _get_original_dialog_on_dismiss(self, dialog: DialogControl):
+        wrapper = getattr(dialog, _MANAGED_DIALOG_DISMISS_WRAPPER, None)
+        if wrapper is not None and dialog.on_dismiss is wrapper:
+            return getattr(dialog, _MANAGED_DIALOG_DISMISS_ORIGINAL, None)
+        return dialog.on_dismiss
+
+    def _wrap_dialog_on_dismiss(self, dialog: DialogControl) -> None:
+        original_on_dismiss = self._get_original_dialog_on_dismiss(dialog)
+
+        async def wrapped_on_dismiss(*args):
+            # Keep the dialog mounted until Flutter reports dismiss. Removing it
+            # earlier can drop the post-animation dismiss callback entirely.
+            self._restore_dialog_on_dismiss(dialog)
+            self._remove_dialog(dialog)
+            e = args[0]
+            if (
+                original_on_dismiss and (e.data is None or e.data)
+                # e.data == True for TimePicker and DatePicker if they were
+                # dismissed without changing the value
+            ):
+                await dialog._trigger_event("dismiss", e)
+
+        setattr(dialog, _MANAGED_DIALOG_DISMISS_ORIGINAL, original_on_dismiss)
+        setattr(dialog, _MANAGED_DIALOG_DISMISS_WRAPPER, wrapped_on_dismiss)
+        dialog.on_dismiss = wrapped_on_dismiss
+
+    def _restore_dialog_on_dismiss(self, dialog: DialogControl) -> None:
+        original_on_dismiss = getattr(dialog, _MANAGED_DIALOG_DISMISS_ORIGINAL, None)
+        if hasattr(dialog, _MANAGED_DIALOG_DISMISS_ORIGINAL):
+            delattr(dialog, _MANAGED_DIALOG_DISMISS_ORIGINAL)
+        if hasattr(dialog, _MANAGED_DIALOG_DISMISS_WRAPPER):
+            delattr(dialog, _MANAGED_DIALOG_DISMISS_WRAPPER)
+        dialog.on_dismiss = original_on_dismiss
+
+    def _remove_dialog(self, dialog: DialogControl) -> None:
+        if dialog in self._dialogs.controls:
+            self._dialogs.controls.remove(dialog)
+            self._dialogs.update()
+
     async def show_drawer(self):
         """
         Show the drawer.

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet/controls/context.py

@@ -101,6 +101,12 @@ class Context:
         """
         self.__components_mode = True
 
+    def disable_components_mode(self):
+        """
+        Disables components mode in the current context.
+        """
+        self.__components_mode = False
+
     def is_components_mode(self) -> bool:
         """
         Returns whether the current context is in components mode.

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet/controls/material/navigation_rail.py

@@ -56,13 +56,13 @@ class NavigationRailDestination(Control):
     Represents a destination in a `NavigationRail`.
     """
 
-    icon: Optional[IconDataOrControl] = None
+    icon: IconDataOrControl
     """
     The [name of the icon](https://flet.dev/docs/types/icons) or `Control` of the \
     destination.
 
-    If `selected_icon` is provided, this will only be displayed when the destination is
-    not selected.
+    If :attr:`selected_icon` is provided, this will only be displayed when the
+    destination is not selected.
 
     To make the NavigationRail more accessible, consider choosing an icon with a stroked
     and filled version, such as `Icons.CLOUD` and `Icons.CLOUD_QUEUE`. The icon
@@ -105,6 +105,7 @@ class NavigationRail(LayoutControl):
     A material widget that is meant to be displayed at the left or right of an app to \
     navigate between a small number of views, typically between three and five.
 
+    Example:
     ```python
     ft.NavigationRail(
         selected_index=0,
@@ -208,6 +209,31 @@ class NavigationRail(LayoutControl):
     rendered when `extended=True`.
     """
 
+    pin_leading_to_top: bool = True
+    """
+    Whether to pin the :attr:`leading` control to the top of the rail.
+
+    If `False`, the leading control becomes part of the main group together with the
+    destinations and participates in scrolling/alignment.
+    """
+
+    pin_trailing_to_bottom: bool = False
+    """
+    Whether to pin the :attr:`trailing` control to the bottom of the rail.
+
+    If `False`, the trailing control becomes part of the main group together with the
+    destinations and participates in scrolling/alignment.
+    """
+
+    scrollable: bool = False
+    """
+    Whether the main group of :attr:`destinations` should become scrollable when \
+    vertical space is insufficient.
+
+    When :attr:`pin_leading_to_top` or :attr:`pin_trailing_to_bottom` are
+    `False`, the respective controls also become part of the scrollable group.
+    """
+
     min_width: Annotated[
         Optional[Number],
         V.ge(0),

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet/version.py

@@ -16,7 +16,7 @@ __all__ = [
 ]
 
 # set by CI
-flet_version = "0.84.0.dev0"
+flet_version = "0.85.0.dev0"
 """
 The Flet version in use.
 

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet
-Version: 0.84.0.dev0
+Version: 0.85.0.dev0
 Summary: Flet for Python - easily build interactive multi-platform apps in Python
 Author-email: "Appveyor Systems Inc." <hello@flet.dev>
 License-Expression: Apache-2.0
@@ -9,23 +9,23 @@ Project-URL: Repository, https://github.com/flet-dev/flet
 Project-URL: Documentation, https://flet.dev/docs/
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "cli"
-Requires-Dist: flet-web==0.84.0.dev0; extra == "web"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "cli"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "web"
 Requires-Dist: oauthlib>=3.2.2; platform_system != "Pyodide"
 Requires-Dist: httpx>=0.28.1; platform_system != "Pyodide"
 Requires-Dist: repath>=0.9.0
 Requires-Dist: msgpack>=1.1.0
 Requires-Dist: typing-extensions; python_version < "3.11"
 Provides-Extra: all
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "all"
-Requires-Dist: flet-web==0.84.0.dev0; extra == "all"
-Requires-Dist: flet-desktop==0.84.0.dev0; extra == "all"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "all"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "all"
+Requires-Dist: flet-desktop==0.85.0.dev0; extra == "all"
 Provides-Extra: cli
-Requires-Dist: flet-cli==0.84.0.dev0; extra == "cli"
+Requires-Dist: flet-cli==0.85.0.dev0; extra == "cli"
 Provides-Extra: desktop
-Requires-Dist: flet-desktop==0.84.0.dev0; extra == "desktop"
+Requires-Dist: flet-desktop==0.85.0.dev0; extra == "desktop"
 Provides-Extra: web
-Requires-Dist: flet-web==0.84.0.dev0; extra == "web"
+Requires-Dist: flet-web==0.85.0.dev0; extra == "web"
 
 <p align="center">
   <a href="https://flet.dev"><img src="https://raw.githubusercontent.com/flet-dev/flet/refs/heads/main/media/logo/flet-logo.svg" height="150" alt="Flet logo"></a>

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ src/flet/components/hooks/__init__.py
 src/flet/components/hooks/hook.py
 src/flet/components/hooks/use_callback.py
 src/flet/components/hooks/use_context.py
+src/flet/components/hooks/use_dialog.py
 src/flet/components/hooks/use_effect.py
 src/flet/components/hooks/use_memo.py
 src/flet/components/hooks/use_ref.py
@@ -301,5 +302,6 @@ tests/test_observable.py
 tests/test_patch_dataclass.py
 tests/test_session_disconnect_buffering.py
 tests/test_skip_double_update.py
+tests/test_use_dialog.py
 tests/test_validation.py
 tests/test_validation_benchmark.py

{flet-0.84.0.dev0 → flet-0.85.0.dev0}/src/flet.egg-info/requires.txt

@@ -2,10 +2,10 @@ repath>=0.9.0
 msgpack>=1.1.0
 
 [:extra == "cli"]
-flet-cli==0.84.0.dev0
+flet-cli==0.85.0.dev0
 
 [:extra == "web"]
-flet-web==0.84.0.dev0
+flet-web==0.85.0.dev0
 
 [:platform_system != "Pyodide"]
 oauthlib>=3.2.2
@@ -15,15 +15,15 @@ httpx>=0.28.1
 typing-extensions
 
 [all]
-flet-cli==0.84.0.dev0
-flet-web==0.84.0.dev0
-flet-desktop==0.84.0.dev0
+flet-cli==0.85.0.dev0
+flet-web==0.85.0.dev0
+flet-desktop==0.85.0.dev0
 
 [cli]
-flet-cli==0.84.0.dev0
+flet-cli==0.85.0.dev0
 
 [desktop]
-flet-desktop==0.84.0.dev0
+flet-desktop==0.85.0.dev0
 
 [web]
-flet-web==0.84.0.dev0
+flet-web==0.85.0.dev0

flet-0.85.0.dev0/tests/test_use_dialog.py

@@ -0,0 +1,166 @@
+import weakref
+
+import pytest
+
+import flet as ft
+from flet.components.component import Component, Renderer
+from flet.controls.base_control import BaseControl
+from flet.controls.context import _context_page
+from flet.controls.control_event import ControlEvent
+from flet.messaging.protocol import configure_encode_object_for_msgpack
+
+
+class FakeSession:
+    def __init__(self):
+        self.patch_calls: list[tuple[object, dict]] = []
+        self.scheduled_updates: list[object] = []
+        self.index: dict[int, object] = {}
+
+    def patch_control(self, control, **kwargs):
+        self.patch_calls.append((control, kwargs))
+        control_id = getattr(control, "_i", None)
+        if control_id is not None:
+            self.index[control_id] = control
+
+    def schedule_update(self, control):
+        self.scheduled_updates.append(control)
+
+    def schedule_effect(self, hook, is_cleanup):
+        pass
+
+    async def after_event(self, control):
+        pass
+
+
+def render_component(component: Component, page: ft.Page) -> None:
+    component._state.hook_cursor = 0
+    token = _context_page.set(page)
+    try:
+        renderer = Renderer(component)
+        with renderer.with_context(), renderer._Frame(renderer, component):
+            component.fn(*component.args, **component.kwargs)
+    finally:
+        _context_page.reset(token)
+
+
+def create_page() -> tuple[ft.Page, FakeSession]:
+    session = FakeSession()
+    page = ft.Page(sess=session)
+    page._dialogs._parent = weakref.ref(page)
+    return page, session
+
+
+@pytest.mark.asyncio
+async def test_use_dialog_waits_for_dismiss_before_removing_dialog():
+    page, session = create_page()
+    show = True
+    dismiss_calls: list[str] = []
+
+    def body():
+        ft.use_dialog(
+            ft.AlertDialog(
+                title=ft.Text("Hello"),
+                on_dismiss=lambda e: dismiss_calls.append(e.name),
+            )
+            if show
+            else None
+        )
+
+    component = Component(fn=body, args=(), kwargs={})
+
+    render_component(component, page)
+
+    assert session.scheduled_updates == [page._dialogs]
+    assert len(page._dialogs.controls) == 1
+
+    dialog = page._dialogs.controls[0]
+    session.patch_calls.clear()
+    session.scheduled_updates.clear()
+
+    show = False
+    render_component(component, page)
+
+    assert page._dialogs.controls == [dialog]
+    assert dialog.open is False
+    assert session.patch_calls == [(dialog, {})]
+    assert session.scheduled_updates == []
+
+    await dialog.on_dismiss(ControlEvent(control=dialog, name="dismiss", data=None))
+
+    assert page._dialogs.controls == []
+    assert dismiss_calls == ["dismiss"]
+    assert session.patch_calls[-1] == (page._dialogs, {})
+
+
+@pytest.mark.asyncio
+async def test_use_dialog_unmount_keeps_dialog_until_dismiss_event():
+    page, session = create_page()
+    dismiss_calls: list[str] = []
+
+    def body():
+        ft.use_dialog(
+            ft.AlertDialog(
+                title=ft.Text("Hello"),
+                on_dismiss=lambda e: dismiss_calls.append(e.name),
+            )
+        )
+
+    component = Component(fn=body, args=(), kwargs={})
+    render_component(component, page)
+
+    dialog = page._dialogs.controls[0]
+    session.patch_calls.clear()
+    session.scheduled_updates.clear()
+    component._schedule_effect = lambda hook, is_cleanup=False: (
+        hook.cleanup() if is_cleanup and hook.cleanup else None
+    )
+
+    component.will_unmount()
+
+    assert page._dialogs.controls == [dialog]
+    assert dialog.open is False
+    assert session.patch_calls == [(dialog, {})]
+    assert session.scheduled_updates == []
+
+    await dialog.on_dismiss(ControlEvent(control=dialog, name="dismiss", data=None))
+
+    assert page._dialogs.controls == []
+    assert dismiss_calls == ["dismiss"]
+    assert session.patch_calls[-1] == (page._dialogs, {})
+
+
+@pytest.mark.asyncio
+async def test_show_dialog_still_removes_dialog_on_dismiss():
+    page, session = create_page()
+    dismiss_calls: list[str] = []
+    dialog = ft.AlertDialog(
+        title=ft.Text("Hello"),
+        on_dismiss=lambda e: dismiss_calls.append(e.name),
+    )
+
+    page.show_dialog(dialog)
+
+    assert page._dialogs.controls == [dialog]
+    assert dialog.open is True
+    assert session.patch_calls == [(page._dialogs, {})]
+
+    await dialog.on_dismiss(ControlEvent(control=dialog, name="dismiss", data=None))
+
+    assert page._dialogs.controls == []
+    assert dismiss_calls == ["dismiss"]
+    assert session.patch_calls[-1] == (page._dialogs, {})
+
+
+def test_prepare_dialog_does_not_store_callbacks_in_serialized_fields():
+    page, _ = create_page()
+    dialog = ft.AlertDialog(
+        title=ft.Text("Hello"),
+        on_dismiss=lambda e: None,
+    )
+
+    page._prepare_dialog(dialog)
+
+    encoded = configure_encode_object_for_msgpack(BaseControl)(dialog)
+
+    assert encoded["on_dismiss"] is True
+    assert "_internals" not in encoded