add bookmark tests for sidebar, accordion, navset

Author: karangattu

shiny/bookmark/_restore_state.py

@@ -391,11 +391,11 @@ def get_current_restore_context() -> RestoreContext | None:
 
 
 @overload
-def restore_input(resolved_id: ResolvedId, default: Any) -> Any: ...
+def restore_input(resolved_id: ResolvedId, default: Optional[Any] = None) -> Any: ...
 @overload
 def restore_input(resolved_id: None, default: T) -> T: ...
 @add_example()
-def restore_input(resolved_id: ResolvedId | None, default: Any) -> Any:
+def restore_input(resolved_id: ResolvedId | None, default: Optional[Any] = None) -> Any:
     """
     Restore an input value
 

shiny/ui/_accordion.py

@@ -245,6 +245,22 @@ def accordion(
                 "All `accordion(*args)` must be of type `AccordionPanel` which can be created using `accordion_panel()`"
             )
 
+    # Since multiple=False requires an id, we always include one,
+    # but only create a binding when it is provided
+    binding_class_value: TagAttrs | None = None
+    if id is None:
+        id = private_random_id("bslib_accordion")
+        binding_class_value = None
+    else:
+        binding_class_value = {"class": "bslib-accordion-input"}
+
+    accordion_id = resolve_id_or_none(id)
+    has_restored_input = not isinstance(
+        restore_input(accordion_id, MISSING), MISSING_TYPE
+    )
+    open = restore_input(accordion_id, open)
+    print(f"restored open: {restore_input(accordion_id, MISSING)}")
+
     is_open: list[bool] = []
     if open is None:
         is_open = [False for _ in panels]
@@ -256,27 +272,18 @@ def accordion(
         #
         is_open = [panel._data_value in open for panel in panels]
 
-    # Open the first panel by default
-    if open is not False and len(is_open) > 0 and not any(is_open):
-        is_open[0] = True
+    if not has_restored_input:
+        # Open the first panel by default
+        if open is not False and len(is_open) > 0 and not any(is_open):
+            is_open[0] = True
 
     if (not multiple) and sum(is_open) > 1:
         raise ValueError("Can't select more than one panel when `multiple = False`")
 
-    # Since multiple=False requires an id, we always include one,
-    # but only create a binding when it is provided
-    binding_class_value: TagAttrs | None = None
-    if id is None:
-        id = private_random_id("bslib_accordion")
-        binding_class_value = None
-    else:
-        binding_class_value = {"class": "bslib-accordion-input"}
-
-    accordion_id = resolve_id_or_none(id)
-    for panel, open in zip(panels, is_open):
+    for panel, panel_is_open in zip(panels, is_open):
         panel._accordion_id = accordion_id
         panel._is_multiple = multiple
-        panel._is_open = restore_input(accordion_id, open)
+        panel._is_open = panel_is_open
 
     panel_tags = [panel.resolve() for panel in panels]
 

shiny/ui/_sidebar.py

@@ -549,12 +549,17 @@ def sidebar(
 
     resolved_id = resolve_id_or_none(id)
 
+    if resolved_id:
+        restored_open: bool | None = restore_input(resolved_id)
+        if restored_open is not None:
+            open = "open" if restored_open else "closed"
+
     return Sidebar(
         children=children,
         attrs=attrs,
         width=width,
         position=position,
-        open=restore_input(resolved_id, open),
+        open=open,
         id=resolved_id,
         title=title,
         fg=fg,

tests/playwright/ai_generated_apps/bookmark/accordion/test_accordion_bookmarking.py

@@ -0,0 +1,41 @@
+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_accordion_bookmarking_demo(page: Page, app: ShinyAppProc) -> None:
+    page.goto(app.url)
+
+    # Test accordion bookmarking
+    acc_single = controller.Accordion(page, "acc_single")
+    acc_single.expect_open(["Section A"])
+    acc_single.set(["Section B"])
+
+    acc_mod = controller.Accordion(page, "first-acc_mod")
+    acc_mod.expect_open(["Section A"])
+    acc_mod.set(["Section C"])
+
+    # click bookmark button
+    bookmark_button = controller.InputBookmarkButton(page)
+    bookmark_button.click()
+
+    # reload page
+    page.reload()
+
+    acc_single.expect_open(["Section B"])
+    acc_mod.expect_open(["Section C"])
+
+    acc_single.set([])
+    acc_mod.set([])
+
+    bookmark_button.click()
+
+    # reload page
+    page.reload()
+
+    acc_single.expect_open([])
+    acc_mod.expect_open([])

tests/playwright/ai_generated_apps/bookmark/navsets/app-express.py

@@ -1,10 +1,10 @@
 from typing import Any, Dict
 
-from shiny.express import expressify, module, session, ui
+from shiny.express import app_opts, expressify, module, session, ui
 
-ui.page_opts(
-    title="Navsets kitchensink App", id="navsets_collection", bookmark_store="url"
-)
+app_opts(bookmark_store="url")
+
+ui.page_opts(title="Navsets kitchensink App", id="navsets_collection")
 
 
 navset_configs: Dict[str, Dict[str, Dict[str, Any]]] = {
@@ -39,19 +39,10 @@ def create_navset(navset_type: str) -> None:
     for navset_id, params in navset_configs[navset_type].items():
         navset_kwargs = params.copy()
 
-        if "header" in navset_kwargs:
-            header_content = navset_kwargs["header"]["content"]
-            header_id = navset_kwargs["header"]["id"]
-            navset_kwargs["header"] = ui.tags.div(header_content, id=f"{header_id}")
-
-        if "footer" in navset_kwargs:
-            footer_content = navset_kwargs["footer"]["content"]
-            footer_id = navset_kwargs["footer"]["id"]
-            navset_kwargs["footer"] = ui.tags.div(footer_content, id=f"{footer_id}")
-
         with navset_function(id=f"{navset_type}_{navset_id}", **navset_kwargs):
             for suffix in ["a", "b", "c"]:
-                with ui.nav_panel(f"{navset_type}_{suffix}"):
+                id = f"{navset_type}_{suffix}"
+                with ui.nav_panel(id, value=id):
                     ui.markdown(f"{navset_type}_{suffix} content")
 
 

tests/playwright/ai_generated_apps/bookmark/navsets/test_navsets_express_bookmarking.py

@@ -0,0 +1,47 @@
+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_navsets_bookmarking_demo(page: Page, app: ShinyAppProc) -> None:
+    page.goto(app.url)
+
+    # Non-module navsets
+    navset_collection = controller.NavsetTab(page, "navsets_collection")
+    navset_collection.set("navset_underline")
+    navset_underline = controller.NavsetUnderline(page, "navset_underline_default")
+    navset_underline.set("navset_underline_c")
+    navset_collection.set("navset_card_underline")
+    navset_card_underline = controller.NavsetCardUnderline(
+        page, "navset_card_underline_default"
+    )
+    navset_card_underline.set("navset_card_underline_c")
+
+    # module navsets
+    mod_navset_collection = controller.NavsetTab(page, "first-navsets_collection")
+    mod_navset_collection.set("navset_underline")
+    mod_navset_underline = controller.NavsetUnderline(
+        page, "first-navset_underline_default"
+    )
+    mod_navset_underline.set("navset_underline_c")
+    mod_navset_collection.set("navset_card_underline")
+    mod_navset_card_underline = controller.NavsetCardUnderline(
+        page, "first-navset_card_underline_default"
+    )
+    mod_navset_card_underline.set("navset_card_underline_c")
+
+    # click bookmark button
+    bookmark_button = controller.InputBookmarkButton(page)
+    bookmark_button.click()
+
+    # reload page
+    page.reload()
+
+    navset_card_underline.expect_value("navset_card_underline_c")
+    navset_collection.expect_value("navset_card_underline")
+    mod_navset_card_underline.expect_value("navset_card_underline_c")
+    mod_navset_collection.expect_value("navset_card_underline")

tests/playwright/ai_generated_apps/bookmark/sidebar/test_sidebar_express_bookmarking.py

@@ -0,0 +1,37 @@
+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_sidebar_bookmarking_demo(page: Page, app: ShinyAppProc) -> None:
+    page.goto(app.url)
+
+    # Test sidebar bookmarking
+    left_sidebar = controller.Sidebar(page, "sidebar_left")
+    right_sidebar = controller.Sidebar(page, "first-sidebar_right")
+
+    left_sidebar.expect_open(True)
+    right_sidebar.expect_open(True)
+
+    left_sidebar.set(False)
+    right_sidebar.set(False)
+
+    left_sidebar.expect_open(False)
+    right_sidebar.expect_open(False)
+
+    # click bookmark button
+    bookmark_button = controller.InputBookmarkButton(page)
+    bookmark_button.click()
+
+    left_sidebar.set(True)
+    right_sidebar.set(True)
+
+    # reload page
+    page.reload()
+
+    left_sidebar.expect_open(False)
+    right_sidebar.expect_open(False)