R/r6.R

In ashbaldry/classless: Include Classless CSS Frameworks in 'Shiny' Applications

#' Classless Framework
#'
#' @description
#' XxX
#'
#' @param input_id The \code{input} slot that will be used to access the value.
#' @param label Display label for the control
#' @param value Initial value
#' @param placeholder A character string giving the user a hint as to what can be entered into the control
#' @param min Minimum valid value
#' @param max Maximum valid value
#'
#' @export
Classless <- R6::R6Class(
  classname = "Classless",
  public = list(
    #' @description
    #' Create a new Classless object
    #'
    #' @param framework Name of the framework
    #'
    #' @return A new \code{Classless} object
    initialize = function(framework) {
      private$framework <- framework
      NULL
    },

    #' @description
    #' Get the name of the selected classless framework
    #'
    #' @return The name of the framework
    getFramework = function() {
      private$framework
    },

    #' @description
    #' Method required to create a UI page with the required framework
    #'
    #' By default this method is not available and must be created in the extended R6 class
    #'
    #' @param ... Ignored
    createPage = function(...) {
      stop("Method not initialised")
    },

    #' @description
    #' Set UI Code
    #'
    #' @param ui UI code
    addUI = function(ui) {
      private$ui <- self$createPage(ui)
      NULL
    },

    #' @description
    #' Get UI code
    getUI = function() {
      private$ui
    },

    #' @description
    #' Set server function
    #'
    #' @param fun Server function
    addServer = function(fun) {
      private$server <- fun
      NULL
    },

    #' @description
    #' Get server function
    getServer = function() {
      private$server
    },

    #' @description
    #' Run shiny application
    #'
    #' @param ... Arguments passed to \code{\link[shiny]{shinyApp}}
    runApp = function(...) {
      if (is.null(private$ui) || is.null(private$server)) {
        stop("ui and server functions have not been included yet, please add before running application.")
      }

      shiny::shinyApp(
        ui = private$ui,
        server = private$server,
        ...
      )
    },

    #' @description
    #' Run an example application, showing off components available in the classless framework
    #'
    #' See \code{\link{runClasslessExample}} for more details
    #'
    #' @param ... Arguments to passed to \code{\link[shiny]{shinyApp}}
    #'
    #' @return A shiny application with example components
    runExample = function(...) {
      runClasslessExample(framework = self$clone(), ...)
    },

    #' @description
    #' Create an input control for entry of unstructured text values
    #'
    #' @return A text input control that can be added to a UI definition
    textInput = function(input_id, label, value = "", placeholder = "") {
      textCLInput(input_id, label, value = value, placeholder = placeholder)
    },

    #' @description
    #' Create an password control for entry of passwords
    #'
    #' @return A password input control that can be added to a UI definition
    passwordInput = function(input_id, label, value = "", placeholder = "") {
      passwordCLInput(input_id, label, value = value, placeholder = placeholder)
    },

    #' @description
    #' Create a textarea input control for entry of unstructured text values
    #'
    #' @return A textarea input control that can be added to a UI definition
    textAreaInput = function(input_id, label, value = "", placeholder = "") {
      textAreaCLInput(input_id, label, value = value, placeholder = placeholder)
    },

    #' @description
    #' Create a numeric input control for entry of unstructured text values
    #'
    #' @return A numeric input control that can be added to a UI definition
    numericInput = function(input_id, label, value = "", min = NULL, max = NULL, placeholder = "") {
      numericCLInput(input_id, label, value = value, min = min, max = max, placeholder = placeholder)
    },

    #' @description
    #' Create a date input control for entry of unstructured text values
    #'
    #' @return A date input control that can be added to a UI definition
    dateInput = function(input_id, label, value = "", min = NULL, max = NULL, placeholder = "") {
      dateCLInput(input_id, label, value = value, min = min, max = max, placeholder = placeholder)
    },

    #' @description
    #' Create a checkbox that can be used to specify logical values
    #'
    #' @return A checkbox control that can be added to a UI definition
    checkboxInput = function(input_id, label, value = FALSE) {
      checkboxCLInput(input_id, label, value = value)
    },

    #' @description
    #' Create a select list that can be used to choose a single or multiple items from a list of values
    #'
    #' @param choices List of values to select from
    #' @param selected The initially selected value (or multiple values if \code{multiple = TRUE}).
    #' @param multiple Is selection of multiple items allowed?
    #'
    #' @return A select list control that can be added to a UI definition
    selectInput = function(input_id, label, choices, selected = NULL, multiple = FALSE) {
      selectCLInput(input_id, label, choices, selected = selected, multiple = multiple)
    },

    #' @description
    #' Creates an action button whose value is initially zero, and increments by one each time it is pressed.
    #'
    #' @param ... Named attributes to be applied to the button or link.
    #'
    #' @return Abutton control that can be added to a UI definition
    actionButton = function(input_id, label, ...) {
      actionCLButton(input_id, label, ...)
    }
  ),

  private = list(
    framework = NULL,
    ui = NULL,
    server = NULL
  )
)