activate sort for column_def

R/cheetah.R

@@ -34,10 +34,8 @@ cheetah <- function(
       is_named_list(columns) & names(columns) %in% colnames(data)
   )
 
-  columns <-
-    update_col_list_with_classes(data, columns) %>%
-      add_field_to_list() %>%
-      toJSON(auto_unbox = TRUE)
+  columns <- update_col_list_with_classes(data, columns) %>%
+    add_field_to_list()
 
   data_json <- toJSON(data, dataframe = "rows")
   # forward options using x

R/cheetah_utils.R

@@ -26,6 +26,8 @@
 #'   \item \code{"radio"} for radio action columns.
 #' }
 #' @param style Column style.
+#' @param sort Whether to sort the column. Default to FALSE. May also be
+#' a JS callback to create custom logic (does not work yet).
 #'
 #' @export
 #' @return A list of column options to pass to the JavaScript API.
@@ -36,7 +38,8 @@ column_def <- function(
   max_width = NULL,
   column_type = NULL,
   action = NULL,
-  style = NULL
+  style = NULL,
+  sort = FALSE
 ) {
   check_column_type(column_type)
   list(
@@ -46,6 +49,7 @@ column_def <- function(
     maxWidth = max_width,
     columnType = column_type,
     action = action,
-    style = style
+    style = style,
+    sort = sort
   )
 }

tests/testthat/test-utils.R

@@ -10,7 +10,8 @@ test_that("test utils", {
       "maxWidth",
       "columnType",
       "action",
-      "style"
+      "style",
+      "sort"
     )
   )
 })

vignettes/cheetahR.qmd

@@ -12,11 +12,11 @@ knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"
 )
-library(dplyr)
 ```
 
 ```{r setup}
 library(cheetahR)
+library(dplyr)
 ```
 
 ## Your first table
@@ -91,3 +91,41 @@ head(airquality, 10) %>%
     )
   )
 ```
+
+## Sortable columns
+
+To make a column sortable, you can pass `sort = TRUE` to the `column_def()` function:
+
+```{r}
+cheetah(
+  mtcars,
+  columns = list(
+    rownames = column_def(
+      width = 150,
+      sort = TRUE
+    )
+  )
+)
+```
+
+### Coming soon (TBD)
+
+If you want finer control over the sorting logic and provide your own, you can pass a `htmlwidgets::JS` callback instead:
+
+```r
+cheetah(
+  mtcars,
+  columns = list(
+    rownames = column_def(
+      width = 150,
+      sort = htmlwidgets::JS(
+        "sort(order, col, grid) {
+          console.log(order);
+          console.log(col);
+          console.log(grid);
+        }"
+      )
+    )
+  )
+)
+```