R/insert_text.R

In shinyGovstyle: Custom Gov Style Inputs for Shiny

#' Insert Text Function
#'
#' This function loads the insert text component to display additional
#' information in a special format.
#' @param inputId The input slot that will be used to access the value.
#' @param text Text that you want to display on the insert
#' @return a insert text html shiny object
#' @keywords inserttext
#' @export
#' @examples
#' if (interactive()) {
#'   ui <- fluidPage(
#'     shinyGovstyle::header(
#'       main_text = "Example",
#'       secondary_text = "User Examples",
#'       logo="shinyGovstyle/images/moj_logo.png"),
#'     shinyGovstyle::gov_layout(size = "two-thirds",
#'       shinyGovstyle::insert_text(
#'         inputId = "note",
#'         text = "It can take up to 8 weeks to register a lasting power of
#'                 attorney if there are no mistakes in the application."
#'       )
#'     ),
#'     shinyGovstyle::footer(full = TRUE)
#'   )
#'
#'   server <- function(input, output, session) {}
#'   shinyApp(ui = ui, server = server)
#' }

insert_text <- function(inputId, text) {
  govInsert <- shiny::tags$div(shiny::HTML(text),
                               id = inputId,
                               class="govuk-inset-text")
  attachDependency(govInsert)
}