R/word_count.R

In shinyGovstyle: Custom Gov Style Inputs for Shiny

#' Word Count Function
#'
#' This function create tracks the word count and should be used with the
#' text area function
#' @param inputId The input slot of the text area that you want to affect
#' @param input The text input that is associated with the box.
#' @param word_limit Change the word limit if needed.  Default will keep as
#' what was used in text area component
#' @return no value returned. Updates the word count in a shiny app
#' @keywords word count
#' @export
#' @examples
#' if (interactive()) {
#'
#'   ui <- shiny::fluidPage(
#'   shinyjs::useShinyjs(),
#'   shinyGovstyle::header(
#'     "Justice", "", logo="shinyGovstyle/images/moj_logo.png"),
#'   gov_layout(size = "full",
#'            text_area_Input(
#'              inputId = "text_area",
#'              label = "Can you provide more detail?",
#'              hint_label =  "Do not include personal or financial information
#'                             , like your National Insurance number or credit
#'                             card details.",
#'              word_limit = 300)
#'   ),
#'   footer(TRUE)
#'   )
#'
#'   server <- function(input, output, session) {
#'   shiny::observeEvent(input$text_area,
#'                word_count(inputId = "text_area",
#'                           input = input$text_area
#'                )
#'   )
#'   }
#'   shinyApp(ui = ui, server = server)
#'}

word_count <- function(inputId, input, word_limit = NULL){
  if (input == '') {
    word_no <- 0
  }
  else{
    word_no <-sapply(gregexpr("\\S+", input), length)
  }

  shinyjs::html(id = paste0(inputId,"wc"),
                  html = word_no)

  if (!is.null(word_limit)) {
    shinyjs::html(
      id = paste0(inputId,"wl"),
      html = paste("of the", word_limit, "allowed")
    )
  }
}