add fill argument to support bslib cards; fixes #76

Author: daattali

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: shinycssloaders
 Title: Add Loading Animations to a 'shiny' Output While It's Recalculating
-Version: 1.1.0.9004
+Version: 1.1.0.9005
 Authors@R: c(
     person("Dean","Attali",email="[email protected]",role=c("aut","cre"),
         comment = c("Maintainer/developer of shinycssloaders since 2019", ORCID="0000-0002-5645-3493")),

NEWS.md

@@ -1,7 +1,8 @@
 # Unreleased version
 
-- **BREAKING CHANGE** Remove `custom.css` argument that has almost no usage. If you still want to achieve a similar behaviour, use `type=0` 
+- **BREAKING CHANGE** Remove `custom.css` argument that has almost no usage. If you still want to achieve a similar behaviour, use `type=0`
 - Add `delay` argument to show the spinner after a short delay (#95)
+- Add `fill` argument to support {bslib} cards and fillable containers (#76)
 - Add `inline` argument to allow displaying spinner inline (#25)
 - Add `width` argument that can be used in rare cases where the spinner has no inherent width (#85)
 

R/buildSpinner.R

@@ -14,7 +14,8 @@ buildSpinner <- function(
     caption,
     delay,
     inline,
-    width
+    width,
+    fill
 ) {
   spinner_type <- match.arg(spinner_type)
   output_spinner <- (spinner_type == "output")
@@ -57,6 +58,10 @@ buildSpinner <- function(
   if (inline) {
     parent_cls <- paste(parent_cls, "shiny-spinner-inline")
   }
+  if (fill) {
+    # in the future, when bslib becomes more mature, consider using bslib::as_fill_carrier() instead
+    parent_cls <- paste(parent_cls, "html-fill-item html-fill-container")
+  }
 
   child_cls <- "load-container"
   if (output_spinner) {

R/pageSpinner.R

@@ -97,7 +97,8 @@ showPageSpinner <- function(
     hide.ui = FALSE,
     delay = 0,
     inline = FALSE,
-    width = NULL
+    width = NULL,
+    fill = FALSE
   )
 
   hidePageSpinner()

R/withSpinner.R

@@ -36,6 +36,10 @@
 #' is not appearing on the screen due to it having no inherent width (for example, when using
 #' `inline = TRUE` or when the output is inside a CSS flexbox without a specified width). Do not
 #' use this parameter if the spinner already works.
+#' @param fill If `TRUE`, the spinner will act as a "fillable carrier" in the `{bslib}` flexbox system. This is especially
+#' useful when placing a spinner inside a `{bslib}` [card][bslib::card()]. See the documentation on fillable containers
+#' and flexboxes in the `{bslib}` package
+#' for more information.
 #' @seealso [showSpinner()], [hideSpinner()], [showPageSpinner()]
 #' @examples
 #' if (interactive()) {
@@ -71,7 +75,8 @@ withSpinner <- function(
   caption = getOption("spinner.caption"),
   delay = getOption("spinner.delay", default = 0),
   inline = getOption("spinner.inline", default = FALSE),
-  width = getOption("spinner.width")
+  width = getOption("spinner.width"),
+  fill = getOption("spinner.fill", default = FALSE)
 ) {
 
   if (!inherits(ui_element, "shiny.tag") && !inherits(ui_element, "shiny.tag.list")) {
@@ -94,7 +99,8 @@ withSpinner <- function(
     caption = caption,
     delay = delay,
     inline = inline,
-    width = width
+    width = width,
+    fill = fill
   )
 
   htmltools::attachDependencies(spinner, getDependencies())

README.md

@@ -166,6 +166,10 @@ By default, the out-dated output gets hidden while the spinner is showing. You c
 
 A spinner will take up the full available width by default. If you'd like to place multiple spinners next to each other, or if the spinner wraps an inline output (for example, `textOutput(inline = TRUE)`) then you can use the `inline = TRUE` parameter. When using inline spinners, you will generally also want to use the `width` argument.
 
+### Support for {bslib} fillable containers
+
+When using a spinner inside {bslib} cards or other fillable containers, use the `fill = TRUE` parameter to ensure the output will behave correctly in the flexbox.
+
 <h2 id="sponsors">
 
 Sponsors 🏆