Add bookmarking restore capability to input components

Author: karangattu

shiny/bookmark/_restore_state.py

@@ -4,7 +4,7 @@
 from contextlib import contextmanager
 from contextvars import ContextVar, Token
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Literal, Optional
+from typing import TYPE_CHECKING, Any, Literal, Optional, TypeVar, overload
 from urllib.parse import parse_qs, parse_qsl
 
 from .._docstring import add_example
@@ -387,8 +387,13 @@ def get_current_restore_context() -> RestoreContext | None:
     return ctx
 
 
+T = TypeVar("T")
+@overload
+def restore_input(resolved_id: ResolvedId, default: Any) -> Any: ...
+@overload
+def restore_input(resolved_id: None, default: T) -> T: ...
 @add_example()
-def restore_input(resolved_id: ResolvedId, default: Any) -> Any:
+def restore_input(resolved_id: ResolvedId | None, default: Any) -> Any:
     """
     Restore an input value
 
@@ -402,6 +407,9 @@ def restore_input(resolved_id: ResolvedId, default: Any) -> Any:
     default
         A default value to use, if there's no value to restore.
     """
+    if resolved_id is None:
+        return default
+
     if not isinstance(resolved_id, ResolvedId):
         raise TypeError(
             "Expected `resolved_id` to be of type `ResolvedId` which is returned from `shiny.module.resolve_id(id)`."

shiny/playwright/controller/_input_buttons.py

@@ -65,6 +65,47 @@ def expect_disabled(self, value: bool, *, timeout: Timeout = None):
             self.loc, "disabled", re.compile(".*") if value else None, timeout=timeout
         )
 
+class InputBookmarkButton(
+    WidthLocStlyeM,
+    InputActionBase,
+):
+    """Controller for :func:`shiny.ui.input_bookmark_button`."""
+
+    def __init__(
+        self,
+        page: Page,
+        id: str,
+    ) -> None:
+        """
+        Initializes the input bookmark button.
+
+        Parameters
+        ----------
+        page
+            The page where the input bookmark button is located.
+        id
+            The id of the input bookmark button.
+        """
+        super().__init__(
+            page,
+            id=id,
+            loc=f"button#{id}.action-button.shiny-bound-input",
+        )
+
+    def expect_disabled(self, value: bool, *, timeout: Timeout = None):
+        """
+        Expect the input bookmark button to be disabled.
+
+        Parameters
+        ----------
+        value
+            The expected value of the `disabled` attribute.
+        timeout
+            The maximum time to wait for the expectation to be fulfilled. Defaults to `None`.
+        """
+        _expect_attribute_to_have_value(
+            self.loc, "disabled", re.compile(".*") if value else None, timeout=timeout
+        )
 
 class InputDarkMode(UiBase):
     """Controller for :func:`shiny.ui.input_dark_mode`."""

shiny/ui/_input_check_radio.py

@@ -221,7 +221,7 @@ def input_checkbox_group(
     options = _generate_options(
         id=resolved_id,
         type="checkbox",
-        choices=choices,
+        choices=restore_input(resolved_id, choices),
         selected=selected,
         inline=inline,
     )
@@ -292,7 +292,7 @@ def input_radio_buttons(
     options = _generate_options(
         id=resolved_id,
         type="radio",
-        choices=choices,
+        choices=restore_input(resolved_id, choices),
         selected=restore_input(resolved_id, selected),
         inline=inline,
     )

shiny/ui/_input_dark_mode.py

@@ -1,13 +1,17 @@
 from __future__ import annotations
 
+from shiny._namespaces import resolve_id_or_none
+from shiny.bookmark._restore_state import restore_input
+
 __all__ = ("input_dark_mode", "update_dark_mode")
 
 from typing import Literal, Optional
 
 from htmltools import Tag, TagAttrValue, css
 
 from .._docstring import add_example, no_example
-from ..module import resolve_id
+
+# from ..module import resolve_id
 from ..session import Session, require_active_session
 from ._web_component import web_component
 
@@ -46,13 +50,11 @@ def input_dark_mode(
     ----------
     * <https://getbootstrap.com/docs/5.3/customize/color-modes>
     """
+    resolved_id = resolve_id_or_none(id)
 
     if mode is not None:
         mode = validate_dark_mode_option(mode)
 
-    if id is not None:
-        id = resolve_id(id)
-
     return web_component(
         "bslib-input-dark-mode",
         {
@@ -65,9 +67,9 @@ def input_dark_mode(
                 },
             )
         },
-        id=id,
+        id=resolved_id,
         attribute="data-bs-theme",
-        mode=mode,
+        mode=restore_input(resolved_id, mode),
         **kwargs,
     )
 

shiny/ui/_input_date.py

@@ -12,6 +12,8 @@
 from ..module import resolve_id
 from ._html_deps_external import datepicker_deps
 from ._utils import shiny_input_label
+from shiny.bookmark import restore_input
+from shiny.module import resolve_id
 
 
 @add_example()
@@ -111,11 +113,13 @@ def input_date(
     """
 
     resolved_id = resolve_id(id)
+    default_value = value if value is not None else date.today()
+
     return div(
         shiny_input_label(resolved_id, label),
         _date_input_tag(
             id=resolved_id,
-            value=value,
+            value=restore_input(resolved_id, default_value),
             min=min,
             max=max,
             format=format,
@@ -230,12 +234,15 @@ def input_date_range(
     """
 
     resolved_id = resolve_id(id)
+    default_start = start if start is not None else date.today()
+    default_end = end if end is not None else date.today()
+    restored_date_range = restore_input(resolved_id, [default_start, default_end])
     return div(
         shiny_input_label(resolved_id, label),
         div(
             _date_input_tag(
                 id=resolved_id,
-                value=start,
+                value=restored_date_range[0],
                 min=min,
                 max=max,
                 format=format,
@@ -251,7 +258,7 @@ def input_date_range(
             ),
             _date_input_tag(
                 id=resolved_id,
-                value=end,
+                value=restored_date_range[1],
                 min=min,
                 max=max,
                 format=format,

shiny/ui/_input_numeric.py

@@ -4,6 +4,8 @@
 
 from htmltools import Tag, TagChild, css, div, tags
 
+from shiny.bookmark._restore_state import restore_input
+
 from .._docstring import add_example
 from ..module import resolve_id
 from ._utils import shiny_input_label
@@ -69,7 +71,7 @@ def input_numeric(
             id=resolved_id,
             type="number",
             class_="shiny-input-number form-control",
-            value=value,
+            value=restore_input(resolved_id, value),
             min=min,
             max=max,
             step=step,

shiny/ui/_input_select.py

@@ -8,7 +8,7 @@
     "input_select",
     "input_selectize",
 )
-
+from shiny.bookmark._restore_state import restore_input
 import copy
 from json import dumps
 from typing import Any, Mapping, Optional, Union, cast
@@ -111,11 +111,12 @@ def input_selectize(
     * :func:`~shiny.ui.input_radio_buttons`
     * :func:`~shiny.ui.input_checkbox_group`
     """
+    resolved_id = resolve_id(id)
 
     x = input_select(
-        id,
-        label,
-        choices,
+        id=resolved_id,
+        label=label,
+        choices=restore_input(resolved_id, choices),
         selected=selected,
         multiple=multiple,
         selectize=True,
@@ -196,7 +197,9 @@ def input_select(
 
     remove_button = _resolve_remove_button(remove_button, multiple)
 
-    choices_ = _normalize_choices(choices)
+    resolved_id = resolve_id(id)
+
+    choices_ = restore_input(resolved_id, choices)
     if selected is None and not multiple:
         selected = _find_first_option(choices_)
 
@@ -207,8 +210,6 @@ def input_select(
 
     choices_tags = _render_choices(choices_, selected)
 
-    resolved_id = resolve_id(id)
-
     return div(
         shiny_input_label(resolved_id, label),
         div(

shiny/ui/_input_text.py

@@ -4,6 +4,8 @@
 
 from htmltools import Tag, TagChild, css, div, tags
 
+from shiny.bookmark._restore_state import restore_input
+
 from .._docstring import add_example
 from ..module import resolve_id
 from ._html_deps_py_shiny import autoresize_dependency
@@ -76,7 +78,7 @@ def input_text(
             id=resolved_id,
             type="text",
             class_="shiny-input-text form-control",
-            value=value,
+            value=restore_input(resolved_id, value),
             placeholder=placeholder,
             autocomplete=autocomplete,
             spellcheck=spellcheck,
@@ -180,7 +182,7 @@ def input_text_area(
 
     resolved_id = resolve_id(id)
     area = tags.textarea(
-        value,
+        value=restore_input(resolved_id, value),
         id=resolved_id,
         class_=" ".join(classes),
         style=css(width=None if width else "100%", height=height, resize=resize),

tests/playwright/ai_generated_apps/bookmark_tests/input_date/test_bookmark_input_date.py

@@ -0,0 +1,21 @@
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.pytest import create_app_fixture
+from shiny.run import ShinyAppProc
+
+app = create_app_fixture(["app-express.py"])
+
+
+def test_bookmark_date_inputs(page: Page, app: ShinyAppProc) -> None:
+    page.goto(app.url)
+
+    # Test basic date input
+    date1 = controller.InputDate(page, "date1")
+    date1.expect_label("Default date input:")
+    date1.expect_value("2024-01-01")
+
+    text1 = controller.Text(page, "selected_date1")
+    text1.expect_text("Selected date: 2024-01-01")
+
+    bookmark_button = controller.InputActionButton(page, "bookmark_button")