Summary list

Creates a GOV.UK summary list: a set of key and value pairs. To show several lists that need telling apart, wrap each in gov_summary_card().

Usage

gov_summary(inputId, headers, info, border = TRUE)

Arguments

inputId

The id assigned to the component's root element. For Shiny input components this is also the name used to access the value via input$<inputId>.

headers

Character vector of row headers (the keys).

info

Summary information values for the table. Each value accepts a plain character string, or shiny tag objects such as shiny::tags$b("Bold") or a shiny::tagList(). Pass a list rather than a character vector to mix tag and string values.

border

Whether to show borders between rows. Default TRUE.

Value

A div HTML shiny tag object holding the summary list <dl>, which has inputId as its id. The div lets the list change layout based on its own width.

Details

The list switches between GOV.UK's stacked and side-by-side layouts based on its own width rather than the screen's. It stays stacked until it is as wide as a full-width GOV.UK list at GOV.UK's 641px breakpoint (about 580px), so in a narrow column, such as gov_box(size = "two-thirds"), the key column is never too narrow for ordinary words. Browsers without CSS container queries use GOV.UK's screen-width breakpoint instead.

See also

Other Govstyle feedback types: confirmation_panel(), details(), gov_summary_card(), gov_tag(), inset_text(), label_hint(), noti_banner(), value_box(), warning_text()

Examples

# Vector API
headers <- c(
  "Name",
  "Date of birth",
  "Contact information",
  "Contact details"
)
info <- c(
  "Sarah Philips",
  "5 January 1978",
  "72 Guild Street <br> London <br> SE23 6FH",
  "07700 900457 <br> sarah.phillips@example.com"
)

ui <- shinyGovstyle::gov_page(
  shinyGovstyle::header(
    org_name = "Example",
    service_name = "User Examples"
  ),
  shinyGovstyle::gov_main_layout(
    shinyGovstyle::gov_summary("sumID", headers, info)
  ),
  shinyGovstyle::footer(full = TRUE)
)

server <- function(input, output, session) {}
if (interactive()) shinyApp(ui = ui, server = server)