header: Header Function

In shinyGovstyle: Custom Gov Style Inputs for Shiny

Header Function

Description

This function create a header banner. For use at top of the screen

Usage

header(
  org_name = "Shiny example app",
  service_name = NULL,
  logo = "shinyGovstyle/images/Dept_logo.svg",
  main_text = lifecycle::deprecated(),
  secondary_text = lifecycle::deprecated(),
  main_link = lifecycle::deprecated(),
  secondary_link = lifecycle::deprecated(),
  logo_alt_text = "Departmental logo",
  main_alt_text = lifecycle::deprecated(),
  secondary_alt_text = lifecycle::deprecated(),
  logo_width = 66,
  logo_height = 34,
  width = "standard"
)

Arguments

org_name	Organisation name that goes in the header
service_name	Service name to supplement the organisation name
logo	Add a link to a logo which will apply in the header. Use crown to use the crown SVG version on GOV UK
main_text	Use org_name instead
secondary_text	Use service_name instead
main_link	Has no effect and will be removed in shinyGovstyle 1.0.0
secondary_link	Has no effect and will be removed in shinyGovstyle 1.0.0
logo_alt_text	Add alternative text for the logo. Should be used when a logo is used
main_alt_text	Has no effect and will be removed in shinyGovstyle 1.0.0
secondary_alt_text	Has no effect and will be removed in shinyGovstyle 1.0.0
logo_width	Change the logo size width CSS to improve fit
logo_height	Change the logo size height CSS to improve fit
width	Width of the component. One of "standard" (the default, GOV.UK's usual 960px content width), "three-quarters" (three-quarters of the viewport, never narrower than standard), "full" (no max-width, so the container fills the viewport, with grid gutters also removed), or a CSS length (e.g. "1400px", "90vw") for a custom max-width.

Value

a header HTML shiny tag object

See Also

Other Govstyle page structure: cookieBanner(), footer(), gov_page(), layouts, phase_banner(), skip_to_main()

Examples

ui <- shinyGovstyle::gov_page(
  shinyGovstyle::header(
    org_name = "Example",
    service_name = "User Examples",
    logo = "shinyGovstyle/images/moj_logo.png",
    logo_alt_text = "Ministry of Justice Logo"
  )
)

server <- function(input, output, session) {}

if (interactive()) shinyApp(ui = ui, server = server)

shinyGovstyle documentation built on Oct. 16, 2026, 1:07 a.m.