R/nav_input.R

In UchidaMizuki/navigatr: Navigation Menu for Pipe-Friendly Data Processing

#' Build a new input form
#'
#' To create a new input form, give `new_nav_input()` a unique key and the
#' corresponding list of values.
#' By default, the values are empty characters.
#' Each line shows the menu items (keys on the left, value descriptions on the
#' right).
#' By default, the description from [pillar::obj_sum()] is displayed, but you
#' can set `description`.
#' Each menu item can be changed by [itemise()].
#'
#' @param key A unique character vector.
#' @param value A list of values corresponding to the keys. By default, the
#' values are empty characters.
#' @param description A character vector of descriptions for the keys. By
#' default, the description from [pillar::obj_sum()] is displayed.
#' @param ... Additional arguments passed to [vctrs::new_data_frame()].
#' @param class A character vector of subclasses passed to
#' [vctrs::new_data_frame()].
#'
#' @return A `navigatr_nav_input` object, a subclass of class `data.frame`.
#'
#' @seealso [itemise()]
#'
#' @export
new_nav_input <- function(
  key = character(),
  value = list(character()),
  description = NULL,
  ...,
  class = character()
) {
  new_nav(
    key = key,
    value = value,
    description = description,
    ...,
    class = c(class, "navigatr_nav_input")
  )
}

is_nav_input <- function(x) {
  inherits(x, "navigatr_nav_input")
}

#' @export
tbl_sum.navigatr_nav_input <- function(x) {
  out <- x$description %||% purrr::map_chr(x$value, pillar::obj_sum)
  names(out) <- x$key
  out
}

#' @export
vec_ptype_abbr.navigatr_nav_input <- function(x, ...) {
  "nav_input"
}