Skip to content

Commit be3d84a

Browse files
authored
docs(value_box): Improve docs for max_height (#1007)
* docs(value_box): Improve docs for `max_height` * Resave data (GitHub Action) --------- Co-authored-by: gadenbuie <gadenbuie@users.noreply.github.com>
1 parent 2722bb2 commit be3d84a

3 files changed

Lines changed: 12 additions & 5 deletions

File tree

R/sysdata.rda

20 Bytes
Binary file not shown.

R/value-box.R

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@
5555
#' `"text-light"`) to customize the background/foreground colors.
5656
#' @param fill Whether to allow the value box to grow/shrink to fit a fillable
5757
#' container with an opinionated height (e.g., `page_fillable()`).
58+
#' @param max_height The maximum height of the value box or the showcase area.
59+
#' Can be any valid [CSS unit][htmltools::validateCssUnit] (e.g.,
60+
#' `max_height="200px"`).
5861
#' @inheritParams card
5962
#' @param theme_color `r lifecycle::badge("deprecated")` Use `theme` instead.
6063
#'
@@ -227,9 +230,9 @@ new_value_box_theme <- function(class = NULL, bg = NULL, fg = NULL) {
227230
#' Accepted values in the second category are `"auto"`, `"min-content"`,
228231
#' `"max-content"`, a fractional unit (e.g. `2fr`), or a `minmax()` function
229232
#' (e.g., `minmax(100px, 1fr)`).
230-
#' @param max_height,max_height_full_screen A proportion (i.e., a number between
233+
#' @param max_height_full_screen A proportion (i.e., a number between
231234
#' 0 and 1) or any valid [CSS unit][htmltools::validateCssUnit] defining the
232-
#' showcase max_height.
235+
#' showcase `max_height` in a full screen card.
233236
#'
234237
#' @export
235238
#' @rdname value_box

man/value_box.Rd

Lines changed: 7 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)