Dfeshiny header

NAMESPACE

@@ -7,6 +7,7 @@ export(cookies_panel_ui)
 export(custom_disconnect_message)
 export(dfe_cookies_script)
 export(external_link)
+export(header)
 export(init_analytics)
 export(init_cookies)
 export(section_tags)

R/header.R

@@ -0,0 +1,36 @@
+#' DfE header banner
+#'
+#' @description
+#' This function uses `shinyGovstyle::header()` to create a header banner
+#' using the DfE logo.
+#'
+#' @param secondary_text Secondary header to supplement the main text
+#' @param secondary_link Add a link for clicking on secondary header
+#' @return a header html shiny object
+#'
+#' @seealso [shinyGovstyle::header()]
+#' @export
+#' @examples
+#'
+#' if (interactive()) {
+#'   ui <- fluidPage(
+#'     dfeshiny::header(
+#'       secondary_text = "User Examples"
+#'     )
+#'   )
+#'
+#'   server <- function(input, output, session) {}
+#'
+#'   shinyApp(ui = ui, server = server)
+#' }
+header <- function(secondary_text,
+                   secondary_link = "#") {
+  shinyGovstyle::header(
+    logo = "/dfeshiny/DfE_logo_landscape.png",
+    main_text = "",
+    secondary_text = secondary_text,
+    main_link = "https://www.gov.uk/government/organisations/department-for-education",
+    logo_width = 132.98,
+    logo_height = 32
+  )
+}

R/support_panel.R

@@ -23,7 +23,7 @@
 #' @return a HTML div, containing standard support content for a public R Shiny
 #' dashboard in DfE
 #' @seealso [section_tags()]
-#' @seealso [htmltool::tagList()]
+#' @seealso [htmltools::tagList()]
 #' @export
 #'
 #' @examples

_pkgdown.yml

@@ -27,3 +27,7 @@ reference:
   contents:
   - support_panel
   - section_tags
+- title: Header
+  desc: A wrapper for shinyGovstyle::header() that automatically uses the DfE logo.
+  contents:
+  - header

tests/testthat/test-header.R

@@ -0,0 +1,21 @@
+# create output for testing
+
+output <- dfeshiny::header(secondary_text = "hello")
+
+
+test_that("outputs are as expected", {
+  expect_equal(
+    paste(
+      output$children[[2]]$children[[2]]$children[[1]]$children[[1]]
+    ),
+    "hello"
+  )
+
+  expect_equal(
+    paste(
+      output[["children"]][[2]][["children"]][[1]][["children"]][[1]]
+      [["children"]][[1]][["children"]][[1]][["attribs"]][["src"]]
+    ),
+    "/dfeshiny/DfE_logo_landscape.png"
+  )
+})