Update docs

R/columns.R

@@ -211,7 +211,6 @@ set_formatter_star <- function(widget, column, number_of_stars, hoz_align = "cen
 #'  If set to \code{NA} the minimum value of the column is used.
 #' @param max (numeric): The maximum value for progress bar.
 #'  If set to \code{NA} the maximum value of the column is used.
-#' @param max description
 #' @param color (character): Either a single color or a vector of colors
 #' @param legend (character, \code{TRUE}, JavaScript function): If set to \code{TRUE} the value of the cell is displayed.
 #'  Set to \code{NA} to display no value at all.

R/spreadsheet.R

@@ -0,0 +1,25 @@
+## #' @export
+# TODO: Is this useful?
+set_spreadsheet_mode <- function(
+    widget,
+    spreadsheet_rows = NULL,
+    spreadsheet_columns = NULL,
+    spreadsheet_column_definition = NULL,
+    spreadsheet_sheets = NULL,
+    spreadsheet_sheet_tabs = NULL,
+    ...) {
+  spreadsheet_options <- list(
+    spreadsheet = TRUE,
+    spreadsheetRows = spreadsheet_rows,
+    spreadsheetColumns = spreadsheet_columns,
+    spreadsheetColumnDefinition = spreadsheet_column_definition,
+    spreadsheetSheets = spreadsheet_sheets,
+    spreadsheetSheetTabs = spreadsheet_sheet_tabs,
+    ...
+  )
+  widget$x$options <- keys_to_camel_case(utils::modifyList(
+    utils::modifyList(widget$x$options, default_spreadsheet_options),
+    compact(spreadsheet_options)
+  ))
+  return(widget)
+}

R/tabulator.R

@@ -10,7 +10,7 @@
 #' @param theme (character): Theme to apply to the table.
 #' @param width Width of the widget.
 #' @param height Height of the widget.
-#' @param element_id description
+#' @param element_id The unique ID of the widget.
 #' @param ... Named arguments that are appended to the \code{options} parameter.
 #' @import htmlwidgets
 #' @export
@@ -36,7 +36,7 @@ tabulator <- function(
   if (isTRUE(options$spreadsheet)) {
     # ...
     options <- utils::modifyList(default_spreadsheet_options, options)
-  } else {
+  } else if (is.data.frame(data)) {
     data <- fix_colnames(data)
     if (getOption("rtabulator.auto_columns", TRUE) && is.null(options$columns)) {
       options$columns <- create_columns(data, editor = editable)

R/tabulator_options.R

@@ -15,17 +15,21 @@
 #' @param frozen_rows (numeric): Number of frozen rows.
 #' @param index (character): Field to be used as the unique index for each row.
 #' @param group_by (character): Field to group rows by.
-#' @param edit_trigger_event description
-#' @param selectable_rows description
-#' @param pagination (bool): description
-#' @param pagination_size (integer): description
-#' @param pagination_add_row (character): description
-#' @param spreadsheet (bool): description
-#' @param spreadsheet_rows (integer): description
-#' @param spreadsheet_columns (integer): description
-#' @param spreadsheet_column_definition description
-#' @param spreadsheet_sheets (list): description
-#' @param spreadsheet_sheet_tabs (bool): description
+#' @param edit_trigger_event (character): Event that triggers a cell edit.
+#' @param selectable_rows (character, bool, integer) Set to \code{FALSE} to disble row selection.
+#'  If set to \code{TRUE} you can select as many rows as you want.
+#'  If set to \code{"highlight"} rows are just highlighted but do not change state when clicked.
+#'  An integer value sets the maximum number of rows that can be selected.
+#' @param pagination (bool): Whether to enable pagination.
+#' @param pagination_size (integer): Number of rows on each page.
+#' @param pagination_size_selector (list): Add pagination size selector.
+#' @param pagination_add_row (character): Where to add rows to the table when pagination is enabled.
+#' @param spreadsheet (bool): Whether to enable spreadsheet mode.
+#' @param spreadsheet_rows (integer): Number of spreadsheet rows.
+#' @param spreadsheet_columns (integer): Number of spreadsheet columns.
+#' @param spreadsheet_column_definition Column definition used for all columns in the sheet.
+#' @param spreadsheet_sheets (list): List of sheet definitions.
+#' @param spreadsheet_sheet_tabs (bool): Whether to show sheet tabs in the footer.
 #' @param ... Further options.
 #' @seealso \url{https://tabulator.info/docs/6.2/options}
 #' @export
@@ -50,13 +54,14 @@ tabulator_options <- function(
     # Row Grouping
     group_by = NULL,
     # Editing
-    edit_trigger_event = "dblclick",
+    edit_trigger_event = c("dblclick", "click", "focus"),
     # Selection
     selectable_rows = "highlight", # 'highlight', bool or integer
     # Pagination
     pagination = FALSE,
     pagination_size = 10,
-    pagination_add_row = "page",
+    pagination_size_selector = FALSE,
+    pagination_add_row = c("page", "table"),
     # Spreadsheet
     spreadsheet = FALSE,
     spreadsheet_rows = NULL,
@@ -68,6 +73,8 @@ tabulator_options <- function(
   params <- as.list(environment())
   params$layout <- match.arg(layout)
   params$add_row_pos <- match.arg(add_row_pos)
+  params$edit_trigger_event <- match.arg(edit_trigger_event)
+  params$pagination_add_row <- match.arg(pagination_add_row)
   return(c(params, list(...)))
 }