Close #492. Deprecate nav() in favor of nav_panel()

posit-dev · Dec 7, 2023 · 814c636 · 814c636
1 parent a5de5fa
commit 814c636
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 4 deletions.
diff --git a/shiny/ui/__init__.py b/shiny/ui/__init__.py
@@ -86,7 +86,7 @@
 from ._markdown import markdown
 from ._modal import modal_button, modal, modal_show, modal_remove
 from ._navs import (
-    nav,
+    nav_panel,
     nav_menu,
     nav_control,
     nav_spacer,
@@ -102,6 +102,7 @@
     # Deprecated
     navset_pill_card,
     navset_tab_card,
+    nav,
 )
 from ._notification import notification_show, notification_remove
 from ._output import (
@@ -267,7 +268,7 @@
     "modal_show",
     "modal_remove",
     # _navs
-    "nav",
+    "nav_panel",
     "nav_menu",
     "nav_control",
     "nav_spacer",
@@ -283,6 +284,7 @@
     # # Deprecated
     "navset_pill_card",
     "navset_tab_card",
+    "nav",
     # _notification
     "notification_show",
     "notification_remove",

diff --git a/shiny/ui/_navs.py b/shiny/ui/_navs.py
@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 __all__ = (
-    "nav",
+    "nav_panel",
     "nav_menu",
     "nav_control",
     "nav_spacer",
@@ -17,6 +17,7 @@
     # Deprecated - 2023-08-15
     "navset_pill_card",
     "navset_tab_card",
+    "nav",
 )
 
 import copy
@@ -98,7 +99,7 @@ def tagify(self) -> None:
 
 
 @add_example()
-def nav(
+def nav_panel(
     title: TagChild,
     *args: TagChild,
     value: Optional[str] = None,
@@ -1394,3 +1395,24 @@ def navset_tab_card(
         header=header,
         footer=footer,
     )
+
+
+# Deprecated 2023-12-07
+def nav(
+    title: TagChild,
+    *args: TagChild,
+    value: Optional[str] = None,
+    icon: TagChild = None,
+) -> Nav:
+    """Deprecated. Please use `nav_panel()` instead of `nav()`."""
+    warn_deprecated(
+        "`nav()` is deprecated. "
+        "This method will be removed in a future version, "
+        "please use :func:`~shiny.ui.nav_panel` instead."
+    )
+    return nav_panel(
+        title,
+        *args,
+        value=value,
+        icon=icon,
+    )