Update tables when reactive meta values change; add meta to dataKey

Author: glin

NEWS.md

@@ -37,6 +37,7 @@
 * Fixed `JS()` not working when `htmlwidgets` 1.6.3 or later is installed. ([#348](https://github.com/glin/reactable/issues/348))
 * In `reactableTheme()`, `stripedColor` and `highlightColor` now work when using sticky columns. (@grcatlin, [#401](https://github.com/glin/reactable/issues/401))
 * In Crosstalk tables, pagination no longer resets when selecting a row on a page greater than 1. (@msaltieri, [#349](https://github.com/glin/reactable/issues/349))
+* In Shiny apps, tables now update correctly when reactive `meta` values change. (@khusmann, [#416](https://github.com/glin/reactable/issues/416))
 
 ## Breaking changes
 

R/reactable.R

@@ -716,7 +716,7 @@ reactable <- function(
 
   # Create a unique key for the data. The key is used to fully reset state when
   # the data changes (for tables in Shiny).
-  dataKey <- digest::digest(list(data, cols))
+  dataKey <- digest::digest(list(data = data, columns = cols, meta = meta))
 
   # Serialize user-set args only to keep the widget HTML slim
   defaultArgs <- formals()

tests/testthat/test-reactable.R

@@ -48,7 +48,7 @@ test_that("reactable", {
   expected <- list(
     data = data,
     columns = columns,
-    dataKey = digest::digest(list(data, columns)),
+    dataKey = digest::digest(list(data = data, columns = columns, meta = NULL)),
     static = FALSE
   )
   expect_equal(attribs, expected)
@@ -90,7 +90,7 @@ test_that("reactable", {
     className = "tbl",
     style = list(color = "red"),
     inline = TRUE,
-    dataKey = digest::digest(list(data, columns)),
+    dataKey = digest::digest(list(data = data, columns = columns, meta = NULL)),
     static = FALSE
   )
   expect_equal(attribs, expected)
@@ -213,6 +213,20 @@ test_that("data supports Crosstalk", {
   expect_equal(attribs$crosstalkGroup, data$groupName())
 })
 
+test_that("dataKey", {
+  df <- data.frame(x = 1)
+  tbl <- reactable(
+    df,
+    columns = list(x = colDef(cell = function(value) value)),
+    meta = list(m = "data")
+  )
+  attribs <- getAttribs(tbl)
+  expect_equal(
+    attribs$dataKey,
+    digest::digest(list(data = attribs$data, columns = attribs$columns, meta = attribs$meta))
+  )
+})
+
 test_that("columns", {
   df <- data.frame(x = 1)
   expect_error(reactable(df, columns = "x"), "`columns` must be a named list of column definitions")