Updating to update_nav_panel

Author: elnelson575

shiny/api-examples/show_nav_panel/app-core.py renamed to shiny/api-examples/update_nav_panel/app-core.py

@@ -31,22 +31,22 @@ def server(input: Inputs, output: Outputs, session: Session):
     @reactive.effect()
     @reactive.event(input.hideTab)
     def _():
-        ui.hide_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showTab)
     def _():
-        ui.show_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="show")
 
     @reactive.effect()
     @reactive.event(input.hideMenu)
     def _():
-        ui.hide_nav_panel("tabs", target="More")
+        ui.update_nav_panel("tabs", target="More", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showMenu)
     def _():
-        ui.show_nav_panel("tabs", target="More")
+        ui.update_nav_panel("tabs", target="More", method="show")
 
 
 app = App(app_ui, server)

shiny/api-examples/show_nav_panel/app-express.py renamed to shiny/api-examples/update_nav_panel/app-express.py

@@ -27,19 +27,19 @@
     @reactive.effect()
     @reactive.event(input.hideTab)
     def _():
-        ui.hide_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showTab)
     def _():
-        ui.show_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="show")
 
     @reactive.effect()
     @reactive.event(input.hideMenu)
     def _():
-        ui.hide_nav_panel("tabs", target="More")
+        ui.update_nav_panel("tabs", target="More", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showMenu)
     def _():
-        ui.show_nav_panel("tabs", target="More")
+        ui.update_nav_panel("tabs", target="More", method="show")

shiny/express/ui/__init__.py

@@ -109,10 +109,9 @@
     notification_remove,
     nav_spacer,
     navbar_options,
-    hide_nav_panel,
     insert_nav_panel,
     remove_nav_panel,
-    show_nav_panel,
+    update_nav_panel,
     Progress,
     Theme,
     value_box_theme,
@@ -297,9 +296,8 @@
     "navset_hidden",
     "navset_pill",
     "navset_pill_list",
-    "hide_nav_panel",
+    "update_nav_panel",
     "remove_nav_panel",
-    "show_nav_panel",
     "navset_tab",
     "navset_underline",
     "navbar_options",

shiny/ui/__init__.py

@@ -129,10 +129,9 @@
     navset_underline,
 )
 from ._navs_dynamic import (
-    hide_nav_panel,
+    update_nav_panel,
     insert_nav_panel,
     remove_nav_panel,
-    show_nav_panel,
 )
 from ._notification import notification_remove, notification_show
 from ._output import (
@@ -303,10 +302,9 @@
     "navset_pill_list",
     "navset_hidden",
     "navset_bar",
-    "hide_nav_panel",
     "insert_nav_panel",
     "remove_nav_panel",
-    "show_nav_panel",
+    "update_nav_panel",
     "navbar_options",
     # _notification
     "notification_show",

shiny/ui/_navs_dynamic.py

@@ -1,9 +1,4 @@
-__all__ = (
-    "insert_nav_panel",
-    "remove_nav_panel",
-    "hide_nav_panel",
-    "show_nav_panel",
-)
+__all__ = ("insert_nav_panel", "remove_nav_panel", "update_nav_panel")
 
 import sys
 from typing import Optional, Union
@@ -59,8 +54,7 @@ def insert_nav_panel(
     See Also
     --------
     ~remove_nav_panel
-    ~show_nav_panel
-    ~hide_nav_panel
+    ~update_nav_panel
     ~shiny.ui.nav_panel
     """
 
@@ -109,8 +103,7 @@ def remove_nav_panel(id: str, target: str, session: Optional[Session] = None) ->
     See Also
     --------
     ~insert_nav_panel
-    ~show_nav_panel
-    ~hide_nav_panel
+    ~update_nav_panel
     ~shiny.ui.nav_panel
     """
 
@@ -124,80 +117,47 @@ def remove_nav_panel(id: str, target: str, session: Optional[Session] = None) ->
 
 
 @add_example()
-def show_nav_panel(
-    id: str, target: str, select: bool = False, session: Optional[Session] = None
+def update_nav_panel(
+    id: str,
+    target: str,
+    method: Literal["show", "hide"],
+    session: Optional[Session] = None,
 ) -> None:
     """
-    Show a navigation item
+    Show/hide a navigation item
 
     Parameters
     ----------
     id
         The `id` of the relevant navigation container (i.e., `navset_*()` object).
     target
         The `value` of an existing :func:`shiny.ui.nav` item to show.
-    select
-        Whether the nav item's content should also be shown.
+    method
+        The action to perform on the nav_panel (`"show"` or `"hide"`).
     session
         A :class:`~shiny.Session` instance. If not provided, it is inferred via
         :func:`~shiny.session.get_current_session`.
 
     Note
     ----
-    For `show_nav_panel()` to be relevant/useful, a :func:`shiny.ui.nav` item must
-    have been hidden using :func:`~hide_nav_panel`.
+    On reveal, the `nav_panel` will not be the active tab. To change the active tab, use `~update_navs()`
 
     See Also
     --------
-    ~hide_nav_panel
     ~insert_nav_panel
     ~remove_nav_panel
     ~shiny.ui.nav_panel
+    ~update_navs
     """
 
     session = require_active_session(session)
 
     id = resolve_id(id)
-    if select:
-        update_navs(id, selected=target)
 
     msg = {
         "inputId": id,
         "target": target,
-        "type": "show",
-    }
-
-    session._send_message_sync({"shiny-change-tab-visibility": msg})
-
-
-def hide_nav_panel(id: str, target: str, session: Optional[Session] = None) -> None:
-    """
-    Hide a navigation item
-
-    Parameters
-    ----------
-    id
-        The `id` of the relevant navigation container (i.e., `navset_*()` object).
-    target
-        The `value` of an existing :func:`shiny.ui.nav` item to hide.
-    session
-        A :class:`~shiny.Session` instance. If not provided, it is inferred via
-        :func:`~shiny.session.get_current_session`.
-
-    See Also
-    --------
-    ~show_nav_panel
-    ~insert_nav_panel
-    ~remove_nav_panel
-    ~shiny.ui.nav_panel
-    """
-
-    session = require_active_session(session)
-
-    msg = {
-        "inputId": resolve_id(id),
-        "target": target,
-        "type": "hide",
+        "type": method,
     }
 
     session._send_message_sync({"shiny-change-tab-visibility": msg})

tests/playwright/shiny/components/dynamic_navs/app.py

@@ -56,22 +56,22 @@ def _():
     @reactive.effect()
     @reactive.event(input.hideTab)
     def _():
-        ui.hide_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showTab)
     def _():
-        ui.show_nav_panel("tabs", target="Foo")
+        ui.update_nav_panel("tabs", target="Foo", method="show")
 
     @reactive.effect()
     @reactive.event(input.hideMenu)
     def _():
-        ui.hide_nav_panel("tabs", target="Menu")
+        ui.update_nav_panel("tabs", target="Menu", method="hide")
 
     @reactive.effect()
     @reactive.event(input.showMenu)
     def _():
-        ui.show_nav_panel("tabs", target="Menu")
+        ui.update_nav_panel("tabs", target="Menu", method="show")
 
 
 app = App(app_ui, server)

tests/playwright/shiny/components/express_navs/app.py

@@ -22,12 +22,12 @@ def _():
         @reactive.effect()
         @reactive.event(input.showTab)
         def _():
-            ui.show_nav_panel("navset", target="Panel 2")
+            ui.update_nav_panel("navset", target="Panel 2", method="show")
 
         @reactive.effect()
         @reactive.event(input.hideTab)
         def _():
-            ui.hide_nav_panel("navset", target="Panel 2")
+            ui.update_nav_panel("navset", target="Panel 2", method="hide")
 
         @reactive.effect()
         @reactive.event(input.deleteTabs)