fix(page): Allow empty dots in page functions #1095

gadenbuie · 2024-07-28T17:31:21Z

This fixes allowing trailing empty arguments in all of the page functions. This was broken in several page functions because the dots must come after unnamed arguments in the calling functions.

Problem

Here's a minimal reprex that demonstrates the problematic pattern we were using:

page_one <- function(...) {
  bslib::page(..., "b",)
}

page_two <- function(...) {
  bslib::page("b", ...)
}

as.character(page_one("a", ))
#> Error in `dots_list()`:
#> ! Argument 2 can't be empty.
as.character(page_two("a", ))
#> [1] "<body>\n  b\n  a\n</body>"

In reality, we're not adding content but rather we're adding an unnamed dependency object (in the place of "b" above).

Before

library(bslib)
x <- "test"

page(x, ) |> print(browse = FALSE)
#> <body>test</body>

page_fillable(x, ) |> print(browse = FALSE)
#> Error in `dots_list()`:
#> ! Argument 5 can't be empty.

page_fixed(x, ) |> print(browse = FALSE)
#> Error in `dots_list()`:
#> ! Argument 3 can't be empty.

page_fluid(x, ) |> print(browse = FALSE)
#> Error in `dots_list()`:
#> ! Argument 3 can't be empty.

page_navbar(nav_panel(x), ) |> print(browse = FALSE)
#> <body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile bslib-page-navbar html-fill-container" style="padding:0px;gap:0px;">
#>   [...clip...]
#> </body>
page_sidebar(x, ) |> print(browse = FALSE)
#> <body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile bslib-page-sidebar html-fill-container" style="padding:0px;gap:0px;">
#>   [...clip...]
#> </body>

After

pkgload::load_all()
#> ℹ Loading bslib
x <- "test"

page(x, ) |> print(browse = FALSE)
#> <body>test</body>

page_fillable(x, ) |> print(browse = FALSE)
#> <body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile html-fill-container">test</body>

page_fixed(x, ) |> print(browse = FALSE)
#> <div class="container">test</div>

page_fluid(x, ) |> print(browse = FALSE)
#> <div class="container-fluid">test</div>

page_navbar(nav_panel(x), ) |> print(browse = FALSE)
#> <body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile html-fill-container bslib-page-navbar" style="padding:0px;gap:0px;">
#>   [...clip...]
#> </body>

page_sidebar(x, ) |> print(browse = FALSE)
#> <body class="bslib-page-fill bslib-gap-spacing bslib-flow-mobile html-fill-container bslib-page-sidebar" style="padding:0px;gap:0px;">
#>   [...clip...]
#> </body>

cpsievert

Thanks! Please also add unit tests for each page_() function

* Start v0.8.0 release candidate * `yarn build` (GitHub Actions) * ran revdepcheck on cloud. No known issues * `yarn build` (GitHub Actions) * re-run checks * fix(page): Allow empty dots in page functions (#1095) * fix empty trailing arguments in dots of page functions * Add unit tests --------- Co-authored-by: Carson <cpsievert1@gmail.com> * Update snapshot tests * Follow up to #1093: card_image() used to fill by default * Fix R CMD check note about Rd links targets missing package anchors * Missed a few --------- Co-authored-by: cpsievert <cpsievert@users.noreply.github.com> Co-authored-by: Barret Schloerke <barret@posit.co> Co-authored-by: Garrick Aden-Buie <garrick@adenbuie.com> Co-authored-by: gadenbuie <gadenbuie@users.noreply.github.com>

fix empty trailing arguments in dots of page functions

5e8da21

gadenbuie requested a review from cpsievert July 28, 2024 17:31

cpsievert approved these changes Jul 29, 2024

View reviewed changes

Add unit tests

5cdc9ac

cpsievert changed the base branch from rc-v0.8.0 to main July 29, 2024 15:11

cpsievert changed the base branch from main to rc-v0.8.0 July 29, 2024 15:11

cpsievert merged commit 1410b2b into rc-v0.8.0 Jul 29, 2024
1 check passed

cpsievert deleted the fix-empty-dots branch July 29, 2024 15:11

gadenbuie mentioned this pull request Aug 1, 2024

UI page functions don't know how to deal with extra commas like {shiny} does #1097

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(page): Allow empty dots in page functions #1095

fix(page): Allow empty dots in page functions #1095

gadenbuie commented Jul 28, 2024

cpsievert left a comment

fix(page): Allow empty dots in page functions #1095

fix(page): Allow empty dots in page functions #1095

Conversation

gadenbuie commented Jul 28, 2024

Problem

Before

After

cpsievert left a comment

Choose a reason for hiding this comment