chore: Deprecate sidebar_toggle()

NEWS.md

@@ -2,7 +2,7 @@
 
 ## Improvements and bug fixes
 
-* `bs_theme_dependencies()` now avoids unecessarily copying internal package files to R's temporary directory more than once when preparing precompiled theme dependencies (e.g. for a standard `bs_theme()` theme). (#1184)
+* `bs_theme_dependencies()` now avoids unnecessarily copying internal package files to R's temporary directory more than once when preparing precompiled theme dependencies (e.g. for a standard `bs_theme()` theme). (#1184)
 
 * Fixed an issue where the `<main>` areas of `page_sidebar()` and `page_navbar()` (with a `sidebar`) were made to be a fillable containers even when `fillable = FALSE`. (#1188)
 
@@ -14,6 +14,8 @@
 
 * `sidebar()` gains a `fillable` argument to support vertical fill behavior in sidebars. (#1226)
 
+* `sidebar_toggle()` is now officially deprecated in favor of `toggle_sidebar()`. (#1235)
+
 # bslib 0.9.0
 
 ## Breaking changes

R/deprecated.R

@@ -2,6 +2,10 @@
 #'
 #' These functions have been deprecated but remain for backwards compatibility.
 #'
+#' @section v0.9.1:
+#'   The function `sidebar_toggle()` is now deprecated in v0.9.1. Please use
+#'   [toggle_sidebar()] instead.
+#'
 #' @section Navigation Containers:
 #'
 #'   Several functions for navigation containers were renamed in version 0.5.0:
@@ -163,6 +167,17 @@ page_fill <- function(...) {
   page_fillable(...)
 }
 
+#' @rdname deprecated
+#' @export
+sidebar_toggle <- function(id, open = NULL, session = get_current_session()) {
+  lifecycle::deprecate_warn(
+    "0.9.1",
+    "sidebar_toggle()",
+    "toggle_sidebar()"
+  )
+  toggle_sidebar(id = id, open = open, session = session)
+}
+
 #  Legacy Nav Containers --------------------------------------------------
 # This is needed since some shiny functions like `tabPanel()` call
 # `nav()` underneath the hood. In a future release of shiny, we

R/sidebar.R

@@ -458,11 +458,6 @@ toggle_sidebar <- function(id, open = NULL, session = get_current_session()) {
   session$onFlush(callback, once = TRUE)
 }
 
-#' @rdname sidebar
-#' @usage NULL
-#' @export
-sidebar_toggle <- toggle_sidebar
-
 collapse_icon <- function() {
   if (!is_installed("bsicons")) {
     icon <- "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 16 16\" class=\"bi bi-chevron-left collapse-icon\" style=\"fill:currentColor;\" aria-hidden=\"true\" role=\"img\" ><path fill-rule=\"evenodd\" d=\"M11.354 1.646a.5.5 0 0 1 0 .708L5.707 8l5.647 5.646a.5.5 0 0 1-.708.708l-6-6a.5.5 0 0 1 0-.708l6-6a.5.5 0 0 1 .708 0z\"></path></svg>"