Rename header args to heading in utils_accessibility + use tagQuery t…

…o fix bug in nhs_card_tabstop

R/mod_chart_example.R

@@ -12,6 +12,7 @@ mod_chart_example_ui <- function(id) {
     h2_tabstop("Second level"),
     nhs_card_tabstop(
       heading = "example chart title",
+      tabindex = 0,
       nhs_selectInput(
         inputId = ns("bins"),
         label = "Number of bins:",

R/utils_accessibility.R

@@ -1,6 +1,6 @@
 #' h1_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h1
 #'
@@ -9,16 +9,16 @@
 #'
 #' @examples
 #' h1_tabstop("Heading")
-h1_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h1_tabstop <- h1(header, ...) %>%
+h1_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h1_tabstop <- h1(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 #' h2_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h2
 #'
@@ -27,16 +27,16 @@ h1_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' h2_tabstop("Heading")
-h2_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h2_tabstop <- h2(header, ...) %>%
+h2_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h2_tabstop <- h2(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 #' h3_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h3
 #'
@@ -45,16 +45,16 @@ h2_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' h3_tabstop("Heading")
-h3_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h3_tabstop <- h3(header, ...) %>%
+h3_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h3_tabstop <- h3(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 #' h4_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h4
 #'
@@ -63,16 +63,16 @@ h3_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' h4_tabstop("Heading")
-h4_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h4_tabstop <- h4(header, ...) %>%
+h4_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h4_tabstop <- h4(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 #' h5_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h5
 #'
@@ -81,16 +81,16 @@ h4_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' h5_tabstop("Heading")
-h5_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h5_tabstop <- h5(header, ...) %>%
+h5_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h5_tabstop <- h5(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 #' h6_tabstop
 #'
-#' @param header Heading text
+#' @param heading Heading text
 #' @param tabindex Number for tabindex, default 0
 #' @inheritDotParams shiny::h6
 #'
@@ -99,17 +99,17 @@ h5_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' h6_tabstop("Heading")
-h6_tabstop <- function(header, tabindex = 0, ...) {
-  # create header as typical header plus tabindex attribute
-  # ensures header will be stopped at when pressing keyboard tab
-  h6_tabstop <- h6(header, ...) %>%
+h6_tabstop <- function(heading, tabindex = 0, ...) {
+  # create heading as typical heading plus tabindex attribute
+  # ensures heading will be stopped at when pressing keyboard tab
+  h6_tabstop <- h6(heading, ...) %>%
     htmltools::tagAppendAttributes(`tabindex` = tabindex)
 }
 
 
 #' nhs_card_tabstop
 #'
-#' @param header Card title
+#' @param heading Card title
 #' @param tabindex Number for tabindex, default 0
 #' @param ... Card content
 #'
@@ -118,9 +118,12 @@ h6_tabstop <- function(header, tabindex = 0, ...) {
 #'
 #' @examples
 #' nhs_card_tabstop("A card", shiny::p("Some content"))
-nhs_card_tabstop <- function(header, tabindex = 0, ...) {
+nhs_card_tabstop <- function(heading, tabindex = 0, ...) {
   # create nhs_card as typical nhs_card plus tabindex attribute
   # ensures nhs_card will be stopped at when pressing keyboard tab
-  nhs_card_tabstop <- nhs_card(header, ...) %>%
-    htmltools::tagAppendAttributes(`tabindex` = tabindex)
+  htmltools::tagQuery(nhs_card(heading, ...))$
+    find(".nhsuk-card__heading")$
+    removeAttr("tabindex")$
+    addAttr("tabindex" = tabindex)$
+    allTags() # Exclude Linting
 }