Dfeshiny header

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: dfeshiny
 Title: DfE R Shiny Standards
-Version: 0.5.1
+Version: 0.5.1.9000
 Authors@R: c(
     person("Rich", "Bielby", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9070-9969")),

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)

NEWS.md

@@ -1,3 +1,8 @@
+# dfeshiny (development version)
+
+* Added `dfeshiny::header()` function which uses `shinyGovstyle::header()` but it
+automatically uses the DfE logo.
+
 # dfeshiny 0.5.1
 
 * Refresh of disconnect dialogue message and styling

R/header.R

@@ -0,0 +1,34 @@
+#' DfE header banner
+#'
+#' @description
+#' This function uses `shinyGovstyle::header()` to create a header banner
+#' using the DfE logo.
+#'
+#' @param header Text to use for the header of the dashboard
+#' @return a header html shiny object
+#'
+#' @seealso [shinyGovstyle::header()]
+#' @export
+#' @examples
+#'
+#' if (interactive()) {
+#'   ui <- fluidPage(
+#'     dfeshiny::header(
+#'       header = "User Examples"
+#'     )
+#'   )
+#'
+#'   server <- function(input, output, session) {}
+#'
+#'   shinyApp(ui = ui, server = server)
+#' }
+header <- function(header) {
+  shinyGovstyle::header(
+    logo = "/dfeshiny/DfE_logo_landscape.png",
+    main_text = "",
+    secondary_text = header,
+    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/test_dashboard/ui.R

@@ -2,6 +2,10 @@ ui <- function(input, output, session) {
   shiny::fluidPage(
     shinyjs::useShinyjs(),
 
+    # header function ---------------------------------------------------------
+
+    dfeshiny::header("Header Example"),
+
     # Custom disconnect =======================================================
     custom_disconnect_message(
       refresh = "Refresh page",

tests/testthat/test-header.R

@@ -0,0 +1,21 @@
+# create output for testing
+
+output <- dfeshiny::header(header = "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"
+  )
+})