don't expose class and attr yet

Author: cderv

R/table-helper.R

@@ -27,10 +27,6 @@
 #'   accessibility.
 #' @param use_base64 Logical, whether to base64 encode the content (recommended
 #'   for complex content with special characters or when content includes quotes)
-#' @param class Optional CSS class(es) to add to the element. While this works for
-#'   both span and div elements, it's more commonly used with div elements.
-#' @param attrs Named list of additional HTML attributes to add to the element.
-#'   For example: `list(id = "my-element", title = "Tooltip text")`
 #'
 #' @return Character string containing the HTML element with appropriate data-qmd attributes
 #'
@@ -47,11 +43,6 @@
 #' tbl_qmd_span_base64("Complex $\\LaTeX$ content")
 #' tbl_qmd_span_raw("Simple text")
 #'
-#' # Use with custom attributes
-#' tbl_qmd_span("**Important note**", attrs = list(title = "Hover for more info"))
-#' tbl_qmd_div("Content here", class = "callout",
-#'             attrs = list(id = "special-note", tabindex = "0"))
-#'
 #' # Use with different HTML table packages
 #' \dontrun{
 #' # With kableExtra
@@ -85,7 +76,12 @@ NULL
   invisible(TRUE)
 }
 
-
+#' @inheritParams tbl_qmd_elements
+#' @param class Optional CSS class(es) to add to the element. While this works for
+#'   both span and div elements, it's more commonly used with div elements.
+#' @param attrs Named list of additional HTML attributes to add to the element.
+#'   For example: `list(id = "my-element", title = "Tooltip text")`
+#' @noRd
 .tbl_qmd_element <- function(
   tag,
   content,
@@ -132,82 +128,64 @@ NULL
 tbl_qmd_span <- function(
   content,
   display = NULL,
-  use_base64 = TRUE,
-  class = NULL,
-  attrs = NULL
+  use_base64 = TRUE
 ) {
-  .tbl_qmd_element("span", content, display, use_base64, class, attrs)
+  .tbl_qmd_element("span", content, display, use_base64)
 }
 
 #' @rdname tbl_qmd_elements
 #' @export
 tbl_qmd_div <- function(
   content,
   display = NULL,
-  use_base64 = TRUE,
-  class = NULL,
-  attrs = NULL
+  use_base64 = TRUE
 ) {
-  .tbl_qmd_element("div", content, display, use_base64, class, attrs)
+  .tbl_qmd_element("div", content, display, use_base64)
 }
 #' @rdname tbl_qmd_elements
 #' @export
 tbl_qmd_span_base64 <- function(
   content,
-  display = NULL,
-  class = NULL,
-  attrs = NULL
+  display = NULL
 ) {
   tbl_qmd_span(
     content,
     display,
-    use_base64 = TRUE,
-    class = class,
-    attrs = attrs
+    use_base64 = TRUE
   )
 }
 
 #' @rdname tbl_qmd_elements
 #' @export
 tbl_qmd_div_base64 <- function(
   content,
-  display = NULL,
-  class = NULL,
-  attrs = NULL
+  display = NULL
 ) {
-  tbl_qmd_div(content, display, use_base64 = TRUE, class = class, attrs = attrs)
+  tbl_qmd_div(content, display, use_base64 = TRUE)
 }
 
 #' @rdname tbl_qmd_elements
 #' @export
 tbl_qmd_span_raw <- function(
   content,
-  display = NULL,
-  class = NULL,
-  attrs = NULL
+  display = NULL
 ) {
   tbl_qmd_span(
     content,
     display,
-    use_base64 = FALSE,
-    class = class,
-    attrs = attrs
+    use_base64 = FALSE
   )
 }
 
 #' @rdname tbl_qmd_elements
 #' @export
 tbl_qmd_div_raw <- function(
   content,
-  display = NULL,
-  class = NULL,
-  attrs = NULL
+  display = NULL
 ) {
   tbl_qmd_div(
     content,
     display,
-    use_base64 = FALSE,
-    class = class,
-    attrs = attrs
+    use_base64 = FALSE
   )
 }

man/tbl_qmd_elements.Rd

@@ -9,19 +9,6 @@ test_that("tbl_qmd_span generates correct HTML with base64 encoding", {
     "<span data-qmd-base64=\"JFxhbHBoYSArIFxiZXRhJA==\">Greek formula</span>",
     fixed = TRUE
   )
-  expect_match(
-    tbl_qmd_span("**bold text**", class = "highlight"),
-    "<span data-qmd-base64=\"Kipib2xkIHRleHQqKg==\" class=\"highlight\">**bold text**</span>",
-    fixed = TRUE
-  )
-  expect_match(
-    tbl_qmd_span(
-      "**Important note**",
-      attrs = list(title = "Hover for more info")
-    ),
-    "<span data-qmd-base64=\"KipJbXBvcnRhbnQgbm90ZSoq\" title=\"Hover for more info\">**Important note**</span>",
-    fixed = TRUE
-  )
 })
 
 test_that("tbl_qmd_span_raw generates correct HTML with raw encoding", {
@@ -49,20 +36,6 @@ test_that("tbl_qmd_div generates correct HTML with base64 encoding", {
     "<div data-qmd-base64=\"e3s8IHZpZGVvIGh0dHBzOi8vZXhhbXBsZS5jb20gPn19\">[Video content]</div>",
     fixed = TRUE
   )
-
-  expect_match(
-    tbl_qmd_div("Content here", class = "something"),
-    "<div data-qmd-base64=\"Q29udGVudCBoZXJl\" class=\"something\">Content here</div>",
-    fixed = TRUE
-  )
-  expect_match(
-    tbl_qmd_div(
-      "Content here",
-      attrs = list(id = "special-note", tabindex = "0")
-    ),
-    "<div data-qmd-base64=\"Q29udGVudCBoZXJl\" id=\"special-note\" tabindex=\"0\">Content here</div>",
-    fixed = TRUE
-  )
 })
 
 test_that("tbl_qmd_div_raw generates correct HTML with raw encoding", {
@@ -109,3 +82,18 @@ test_that(".tbl_qmd_element correctly handles different tag types", {
     fixed = TRUE
   )
 })
+
+test_that(".tbl_qmd_element handles class and additional attributes", {
+  expect_match(
+    .tbl_qmd_element(
+      "span",
+      "content",
+      "display",
+      TRUE,
+      class = "test-class",
+      attrs = list(id = "test-id", tabindex = "0")
+    ),
+    "<span data-qmd-base64=\"Y29udGVudA==\" class=\"test-class\" id=\"test-id\" tabindex=\"0\">display</span>",
+    fixed = TRUE
+  )
+})