R/footer.R

In shinyGovstyle: Custom Gov Style Inputs for Shiny

#' Footer Function
#'
#' This function create a gov style footer for your page
#'
#' You can add links in the footer to content either within the dashboard or
#' content external to the dashboard using the links_list argument.
#'
#' Links in the footer should be used sparingly and are usually for supporting
#' information pages such as the accessibility statement, privacy notice,
#' cookies information or link to a statement of voluntary adoption of the
#' statistics code of practice.
#'
#' If adding a link to an internal page, generally you will be controlling a
#' hidden tabset so to the end user it looks like it is a new page.
#'
#' @param full Whenever you want to have blank footer or official gov version.
#' Defaults to `FALSE`
#' @param links A vector of actionLinks to be added to the footer, inputIDs
#' are auto-generated and are the snake case version of the link text, e.g.
#' "Accessibility Statement" will have an inputID of accessibility_statement
#' @return a footer HTML shiny tag object
#' @family Govstyle page structure
#' @export
#' @examples
#' ui <- shiny::fluidPage(
#'   shinyGovstyle::header(
#'     org_name = "Example",
#'     service_name = "User Examples",
#'     logo = "shinyGovstyle/images/moj_logo.png",
#'     logo_alt_text = "Ministry of Justice logo"
#'   ),
#'   shinyGovstyle::banner(
#'     inputId = "banner", type = "beta", "This is a new service"
#'   ),
#'   shiny::tags$br(),
#'   shiny::tags$br(),
#'   shinyGovstyle::footer(full = TRUE)
#' )
#'
#' server <- function(input, output, session) {}
#'
#' if (interactive()) shinyApp(ui = ui, server = server)
#'
#' # Add links
#' footer(links = c("Accessibility statement", "Cookies"))
#'
#' # Add links, internal and external
#' footer(
#'   links = c(
#'     "Accessibility statement",
#'     "Cookies",
#'     `Government Digital Service` =
#'     "https://www.gov.uk/government/organisations/government-digital-service"
#'   )
#' )
#'
#' # Full app with link controlling a hidden tab and a link to an external page
#' ui <- shiny::fluidPage(
#'   shinyGovstyle::header(
#'     org_name = "Example",
#'     service_name = "User Examples",
#'     logo = "shinyGovstyle/images/moj_logo.png",
#'     logo_alt_text = "Ministry of Justice logo"
#'   ),
#'   shinyGovstyle::banner(
#'     inputId = "banner", type = "beta", "This is a new service"
#'   ),
#'   shiny::tabsetPanel(
#'     type = "hidden",
#'     id = "tabs",
#'     shiny::tabPanel(
#'       "Main content",
#'       value = "main",
#'       heading_text("Hello world!")
#'     ),
#'     shiny::tabPanel(
#'       "Accessibility statement",
#'       value = "accessibility-panel",
#'       heading_text("Accessibility statement")
#'     ),
#'     shiny::tabPanel(
#'       "Cookies",
#'       value = "cookies-panel",
#'       heading_text("Cookies")
#'     ),
#'   ),
#'   shinyGovstyle::footer(
#'     full = TRUE,
#'     links = c(
#'       `Accessibility statement` = "accessibility_footer_link",
#'       `Cookies` = "cookies_footer_link",
#'       `Government Digital Service` =
#'        paste0(
#'          "https://www.gov.uk/government/",
#'          "organisations/government-digital-service"
#'        )
#'     )
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   shiny::observeEvent(input$accessibility_footer_link, {
#'     shiny::updateTabsetPanel(
#'       session,
#'       "tabs",
#'       selected = "accessibility-panel"
#'     )
#'   })
#'   shiny::observeEvent(input$cookies_footer_link, {
#'     shiny::updateTabsetPanel(
#'       session,
#'       "tabs",
#'       selected = "cookies-panel"
#'     )
#'   })
#' }
#'
#' if (interactive()) shinyApp(ui = ui, server = server)
footer <- function(full = FALSE, links = NULL) {
  if (is.null(names(links))) {
    link_names <- links
  } else {
    link_names <- names(links)
    link_names[link_names == ""] <- links[link_names == ""]
  }

  # The HTML div to be returned
  gov_footer <- shiny::tags$footer(
    class = "govuk-footer ",
    role = "contentinfo",
    shiny::div(
      class = "govuk-width-container ",
      shiny::div(
        class = "govuk-footer__meta",
        if (full == FALSE) {
          shiny::div(
            class = "govuk-footer__meta-item govuk-footer__meta-item--grow",
            if (!is.null(links)) {
              shiny::div(
                # Set a visually hidden title for accessibility
                shiny::h2(class = "govuk-visually-hidden", "Support links"),
                shiny::tags$ul(
                  class = "govuk-footer__inline-list",

                  # Generate as many links as needed
                  mapply(
                    footer_link,
                    links,
                    link_names,
                    SIMPLIFY = FALSE,
                    USE.NAMES = FALSE
                  )
                )
              )
            }
          )
        } else {
          shiny::tagList(
            shiny::div(
              class = "govuk-footer__meta-item govuk-footer__meta-item--grow",
              if (!is.null(links)) {
                shiny::div(
                  # Set a visually hidden title for accessibility
                  shiny::h2(class = "govuk-visually-hidden", "Support links"),
                  shiny::tags$ul(
                    class = "govuk-footer__inline-list",

                    # Generate as many links as needed
                    mapply(
                      footer_link,
                      links,
                      link_names,
                      SIMPLIFY = FALSE,
                      USE.NAMES = FALSE
                    )
                  )
                )
              },
              shiny::tag(
                "svg",
                list(
                  role = "presentation",
                  focusable = "false",
                  class = "govuk-footer__licence-logo",
                  xmlns = "http://www.w3.org/2000/svg",
                  viewbox = "0 0 483.2 195.7",
                  height = "17",
                  width = "41",
                  shiny::tag(
                    "path",
                    list(
                      fill = "currentColor",
                      d = paste0(
                        "M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7",
                        "zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21",
                        ".1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7",
                        "-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1",
                        "-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97",
                        ".8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.",
                        "7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8",
                        "h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47",
                        ".1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145",
                        " 97.8 145"
                      )
                    )
                  )
                )
              ),
              shiny::tags$span(
                class = "govuk-footer__licence-description",
                "All content is available under the",
                shiny::tags$a(
                  class = "govuk-footer__link",
                  href = paste0(
                    "https://www.nationalarchives.gov.uk/doc/",
                    "open-government-licence/version/3/"
                  ),
                  rel = "license",
                  "Open Government Licence v3.0"
                ),
                ", except where otherwise stated"
              )
            ),
            shiny::tags$div(
              class = "govuk-footer__meta-item",
              shiny::tags$a(
                class = "govuk-footer__link govuk-footer__copyright-logo",
                href = paste0(
                  "https://www.nationalarchives.gov.uk/information-management",
                  "/re-using-public-sector-information/uk-government-",
                  "licensing-framework/crown-copyright/"
                ),
                "\u00A9 Crown copyright"
              )
            )
          )
        }
      )
    )
  )
  attachDependency(gov_footer)
}

#' Create a footer link for use in `footer()` function
#'
#' @param link Character string containing either link text or url
#' @param link_name Name of a link where a URL has been provided in link_text
#'
#' @returns HTML tag list item
#'
#' @keywords internal
#' @examples
#' # Internal (i.e. within dashboard) link
#' shinyGovstyle:::footer_link("Cookie statement")
#' # Named internal link
#' shinyGovstyle:::footer_link("cookie_statement", "Cookies")
#' # External link
#' shinyGovstyle:::footer_link(
#'   "https://www.gov.uk/government/organisations/government-digital-service",
#'   "Government Digital Service"
#' )
footer_link <- function(link, link_name = NULL) {
  if (grepl("^http|^www", link)) {
    if (is.null(link_name)) {
      warning("Link name provided is NULL for ", link)
      link_name <- link
    }
    shiny::tags$li(
      class = "govuk-footer__inline-list-item",
      shinyGovstyle::external_link(
        link,
        link_name,
        add_warning = FALSE,
        footer = TRUE
      )
    )
  } else {
    if (is.null(link_name)) {
      link_name <- link
    }
    shiny::tags$li(
      class = "govuk-footer__inline-list-item",
      shiny::actionLink(
        class = "govuk-link govuk-footer__link",
        inputId = tolower(gsub(" ", "_", link)),
        label = link_name
      )
    )
  }
}