Render gt tables (#2493)

Fixes #2326
r-lib · Apr 29, 2024 · 84db6a2 · 84db6a2 · maelle · May 3, 2024
1 parent 69351cf
commit 84db6a2
Show file tree

Hide file tree

Showing 18 changed files with 69 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -45,6 +45,7 @@ Suggests:
     diffviewer,
     evaluate,
     gert,
+    gt,
     htmltools,
     htmlwidgets,
     knitr,

diff --git a/NAMESPACE b/NAMESPACE
@@ -89,6 +89,7 @@ S3method(as_html,tag_url)
 S3method(as_html,tag_var)
 S3method(as_html,tag_verb)
 S3method(pkgdown_print,default)
+S3method(pkgdown_print,gt_tbl)
 S3method(pkgdown_print,htmlwidget)
 S3method(print,pkgdown_xml)
 S3method(print,print_yaml)

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,6 @@
 # pkgdown (development version)
 
+* `build_reference()` now automatically renders any tables created by gt (#2326).
 * `build_articles()` now drops a section called "internal". This allows you to have articles that either aren't indexed at all or are included manually elsewhere in the navbar (#2205).
 * `as.pkgdown()` will no longer prompt you to install a missing template package from CRAN, since these are almost always found in GitHub (#2076).
 * `init_site()` once again describes one copy per line, and now uses a better prefix when copying assets from pkgdown itself (#2445).

diff --git a/R/pkgdown_print.R b/R/pkgdown_print.R
@@ -40,3 +40,15 @@ pkgdown_print.htmlwidget <- function(x, visible = TRUE) {
   x$height <- x$height %||% (settings$fig.height * settings$dpi)
   x
 }
+
+#' @export
+pkgdown_print.gt_tbl <- function(x, visible = TRUE) {
+  if (!visible) {
+    return(invisible())
+  }
+
+  htmltools::div(
+    class = "gt-table",
+    gt::as_raw_html(x)
+  )
+}
diff --git a/R/test.R b/R/test.R
@@ -82,6 +82,15 @@ NULL
 #' text(2, 5, "Hello", srt = 30, cex = 2)
 NULL
 
+#' Test case: tables
+#'
+#' @name test-tables
+#' @keywords internal
+#' @family tests
+#' @examples
+#' gt::gt(head(mtcars))
+NULL
+
 #' Test case: don't
 #'
 #' @name test-dont

diff --git a/inst/BS5/assets/pkgdown.scss b/inst/BS5/assets/pkgdown.scss
@@ -420,6 +420,12 @@ pre {
   padding: 1rem 0.5rem;
 }
 
+// Spacing tweaks for gt table
+pre div.gt-table {
+  white-space: normal;
+  margin-top: 1rem;
+}
+
 // "Pop" code out of page margins on small screens to give a little more room
 @include media-breakpoint-down(sm) {
   // div.section div.sourceCode pre

diff --git a/man/index.Rd b/man/index.Rd
diff --git a/man/test-crayon.Rd b/man/test-crayon.Rd
diff --git a/man/test-dont.Rd b/man/test-dont.Rd
diff --git a/man/test-figures.Rd b/man/test-figures.Rd
diff --git a/man/test-links.Rd b/man/test-links.Rd
diff --git a/man/test-lists.Rd b/man/test-lists.Rd
diff --git a/man/test-long-lines.Rd b/man/test-long-lines.Rd
diff --git a/man/test-output-styles.Rd b/man/test-output-styles.Rd
diff --git a/man/test-params.Rd b/man/test-params.Rd
diff --git a/man/test-sexpr-title.Rd b/man/test-sexpr-title.Rd
diff --git a/man/test-tables.Rd b/man/test-tables.Rd
diff --git a/man/test-verbatim.Rd b/man/test-verbatim.Rd