Include option to hide all column labels (#237)

* Add the `column_labels.hidden` argument

* Add option to return an empty string

* Modify function call

* Add line item to `gt_options_default()` tbl

* Update help file using roxygen

* Add tests for `column_labels.hidden = TRUE`

R/gt_options_default.R

@@ -17,6 +17,7 @@ gt_options_default <- function() {
     "column_labels_background_color",     TRUE,  "columns",             NA_character_,
     "column_labels_font_size",            TRUE,  "columns",             "16px",
     "column_labels_font_weight",          TRUE,  "columns",             "initial",
+    "column_labels_hidden",               FALSE,  "columns",            "FALSE",
     "row_group_background_color",         TRUE,  "row_group",           NA_character_,
     "row_group_font_size",                TRUE,  "row_group",           "16px",
     "row_group_font_weight",              TRUE,  "row_group",           "initial",

R/render_as_html.R

@@ -63,7 +63,7 @@ render_as_html <- function(data) {
     columns_component <-
       create_columns_component_h(
         boxh_df, output_df, stub_available, spanners_present,
-        styles_resolved, stubhead_label, col_alignment)
+        styles_resolved, stubhead_label, col_alignment, opts_df)
 
     # Create the body component of the table
     body_component <-

R/tab_options.R

@@ -58,6 +58,7 @@
 #'   when striping rows.
 #' @param row.striping.include_table_body an option for whether to include the
 #'   table body when striping rows.
+#' @param column_labels.hidden an option to hide the column labels.
 #' @return an object of class \code{gt_tbl}.
 #' @examples
 #' # Use `exibble` to create a gt table with
@@ -169,6 +170,7 @@ tab_options <- function(data,
                         column_labels.background.color = NULL,
                         column_labels.font.size = NULL,
                         column_labels.font.weight = NULL,
+                        column_labels.hidden = NULL,
                         row_group.background.color = NULL,
                         row_group.font.size = NULL,
                         row_group.font.weight = NULL,
@@ -329,6 +331,13 @@ tab_options <- function(data,
     opts_df <- opts_df_set(opts_df, "column_labels_font_weight", column_labels.font.weight)
   }
 
+  # column_labels.hidden
+  if (!is.null(column_labels.hidden)) {
+
+    opts_df <- opts_df_set(
+      opts_df, "column_labels_hidden", column_labels.hidden)
+  }
+
   # row_group.background.color
   if (!is.null(row_group.background.color)) {
 

R/utils_render_html.R

@@ -394,7 +394,18 @@ create_columns_component_h <- function(boxh_df,
                                        spanners_present,
                                        styles_resolved,
                                        stubhead_label,
-                                       col_alignment) {
+                                       col_alignment,
+                                       opts_df) {
+
+  # Should the column labels be hidden?
+  column_labels_hidden <-
+    opts_df %>%
+    opts_df_get(option = "column_labels_hidden") %>%
+    as.logical()
+
+  if (column_labels_hidden) {
+    return("")
+  }
 
   # Get the style attrs for the spanner column headings
   spanner_style_attrs <-

tests/testthat/test-cols_label.R

@@ -117,3 +117,29 @@ test_that("the function `cols_label()` works correctly", {
     gt(tbl) %>%
       cols_label(col_a = "col_1"))
 })
+
+test_that("all column labels can be entirely hidden from view", {
+
+  # Expect that the option `column_labels.hidden = TRUE` will
+  # remove the expected node with the classes of `gt_col_heading`
+  # and `gt_right` (i.e., the column labels)
+  expect_length(
+    tbl %>%
+      gt() %>%
+      tab_options(column_labels.hidden = TRUE) %>%
+      render_as_html() %>%
+      xml2::read_html() %>%
+      selection_text("[class='gt_col_heading gt_right']"),
+    0)
+
+  # Expect that not hiding the column labels yields a length
+  # four vector when using the same search
+  expect_length(
+    tbl %>%
+      gt() %>%
+      render_as_html() %>%
+      xml2::read_html() %>%
+      selection_text("[class='gt_col_heading gt_right']"),
+    4)
+})
+