throw warning if layout.clickmode='select' is used with crosstalk

Author: cpsievert

R/utils.R

@@ -723,6 +723,13 @@ verify_key_type <- function(p) {
   for (i in seq_along(keys)) {
     k <- keys[[i]]
     if (is.null(k)) next
+    if (identical(p$x$layout$clickmode, "select")) {
+      warning(
+        "`layout.clickmode` = 'select' is not designed to work well with ",
+        "the R package's linking framework (i.e. crosstalk support).",
+        call. = FALSE
+      )
+    }
     # does it *ever* make sense to have a missing key value?
     uk <- uniq(k)
     if (length(uk) == 1) {

tests/testthat/test-animate-highlight.R

@@ -13,6 +13,13 @@ test_that("SharedData produces key/set in plot_ly", {
   expect_false(tr$`_isSimpleKey` %||% FALSE)
 })
 
+test_that("Warning is thrown when clickmode='select' is used with crosstalk", {
+  expect_warning(
+    plotly_build(layout(p, clickmode = "select")),
+    "not designed to work well"
+  )
+})
+
 test_that("SharedData produces key/set in ggplotly", {
   p <- ggplot(m, aes(x = wt, y = mpg)) + geom_point()
   tr <- plotly_build(p)$x$data[[1]]
@@ -24,6 +31,8 @@ test_that("SharedData produces key/set in ggplotly", {
   expect_false(tr$`_isSimpleKey` %||% FALSE)
 })
 
+
+
 test_that("crosstalk keys are inherited in a layer with inherit = FALSE", {
 
   p <- txhousing %>%