Adding docs and tests, refined

Author: elnelson575

NAMESPACE

@@ -164,6 +164,7 @@ export(toggle_switch)
 export(toggle_tooltip)
 export(toolbar)
 export(toolbar_input_button)
+export(toolbar_input_switch)
 export(tooltip)
 export(update_popover)
 export(update_submit_textarea)

R/toolbar.R

@@ -148,6 +148,27 @@ toolbar_input_button <- function(
 }
 
 
+#' Add toolbar switch input
+#'
+#' @description
+#' A switch input designed to fit well in small places such as in a [toolbar()].
+#'
+#' @examplesIf rlang::is_interactive()
+#' toolbar(
+#'   align = "right",
+#'   toolbar_input_switch(id = "toggle", label = "Enable", value = TRUE),
+#'   toolbar_input_switch(id = "switch", value = FALSE)
+#' )
+#'
+#' @param id The input ID.
+#' @param label The label to display next to the switch. If `NULL`, no label
+#'   is displayed.
+#' @param value The initial state of the switch. Default is `FALSE`.
+#'
+#' @return Returns a switch input suitable for use in a toolbar.
+#'
+#' @family Toolbar components
+#' @export
 toolbar_input_switch <- function(
   id,
   label = NULL,

inst/components/scss/toolbar.scss

@@ -56,15 +56,12 @@
   /* ---- Toolbar Input Switch ---- */
 
   .form-group.shiny-input-container:has(.form-switch) {
-    width: auto;
-  }
-
-  .bslib-input-switch {
-    margin-inline: 2px;
+    width: auto; // Overrides default width which adds unnecessary space
   }
 
-  .form-check {
-    margin-bottom: 0px;
+  .bslib-input-switch.form-check {
+    margin-bottom: 0; // Remove extra form check to ensure alignment with other items
+    margin-inline: 0.5rem; // Spacing so it's not crunched against other toolbar items
   }
 
   /* ---- Adjustments to other elements ---- */

man/toolbar_input_switch.Rd

@@ -237,3 +237,32 @@
         </button>
       </bslib-tooltip>
 
+# toolbar_input_switch() has correct attributes
+
+    Code
+      show_raw_html(toolbar_input_switch(id = "switch_with_label", label = "Flip",
+        value = TRUE))
+    Output
+      <div class="form-group shiny-input-container" data-require-bs-version="5" data-require-bs-caller="input_switch()">
+        <div class="bslib-input-switch form-switch form-check">
+          <input id="switch_with_label" class="form-check-input" type="checkbox" role="switch" checked/>
+          <label class="form-check-label" for="switch_with_label">
+            <span>Flip</span>
+          </label>
+        </div>
+      </div>
+
+---
+
+    Code
+      show_raw_html(toolbar_input_switch(id = "switch_no_label", label = NULL, value = FALSE))
+    Output
+      <div class="form-group shiny-input-container" data-require-bs-version="5" data-require-bs-caller="input_switch()">
+        <div class="bslib-input-switch form-switch form-check">
+          <input id="switch_no_label" class="form-check-input" type="checkbox" role="switch"/>
+          <label class="form-check-label" for="switch_no_label">
+            <span></span>
+          </label>
+        </div>
+      </div>
+

tests/testthat/_snaps/toolbar.md

@@ -337,3 +337,14 @@ test_that("toolbar_input_button() markup snapshots", {
     )
   )
 })
+
+
+# Tests for toolbar_input_switch() #
+test_that("toolbar_input_switch() has correct attributes", {
+  expect_snapshot_html(
+    toolbar_input_switch(id = "switch_with_label", label = "Flip", value = TRUE)
+  )
+  expect_snapshot_html(
+    toolbar_input_switch(id = "switch_no_label", label = NULL, value = FALSE)
+  )
+})