expose closeOnClick option for scout_action

cynkra · Nov 15, 2024 · 0240a2c · 0240a2c
1 parent fceb928
commit 0240a2c
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 5 deletions.
diff --git a/R/scoutbar.R b/R/scoutbar.R
@@ -86,16 +86,19 @@ scout_container <- function(cl, .list, label, ...) {
 #' @param id Unique id.
 #' @param label Action label.
 #' @param description Action description.
+#' @param closeOnClick Whether to close the scoutbar whenever this action is
+#' clicked. Default to TRUE.
 #' @param ... Other options. See \url{https://www.scoutbar.co/docs/actions}.
 #' @export
-scout_action <- function(id, label, description, ...) {
+scout_action <- function(id, label, description, closeOnClick = TRUE, ...) {
   props <- list(
     # id isn't passed to the HTML element so
     # we can't find it in the DOM. This is hacky but
     # works since aria-labels appears.
     ariaLabel = id,
     label = label,
     description = description,
+    closeOnClick = closeOnClick,
     ...
   )
 

diff --git a/inst/www/scoutbar/scoutbar.js b/inst/www/scoutbar/scoutbar.js
diff --git a/inst/www/scoutbar/scoutbar.js.map b/inst/www/scoutbar/scoutbar.js.map
diff --git a/man/scout_action.Rd b/man/scout_action.Rd
diff --git a/srcjs/utils.jsx b/srcjs/utils.jsx
@@ -42,7 +42,10 @@ export const processAction = (el, setValue) => {
       // works since aria-labels appears.
       let val = $(e.currentTarget).attr('aria-label');
       setValue(val);
-      close(false);
+      // Default is true
+      if (children.closeOnClick) {
+        close(false);
+      }
     }
 
     func = createScoutAction(children);

diff --git a/tests/testthat/_snaps/scoutbar/simple-001.json b/tests/testthat/_snaps/scoutbar/simple-001.json
@@ -16,6 +16,7 @@
                 "ariaLabel": 1,
                 "label": "1",
                 "description": "1",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -35,6 +36,7 @@
                 "ariaLabel": 2,
                 "label": "2",
                 "description": "2",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -62,6 +64,7 @@
                     "ariaLabel": 3,
                     "label": "3",
                     "description": "3",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -81,6 +84,7 @@
                     "ariaLabel": 4,
                     "label": "4",
                     "description": "4",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -104,6 +108,7 @@
                 "ariaLabel": 5,
                 "label": "5",
                 "description": "5",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,

diff --git a/tests/testthat/_snaps/scoutbar/simple-002.json b/tests/testthat/_snaps/scoutbar/simple-002.json
@@ -16,6 +16,7 @@
                 "ariaLabel": 1,
                 "label": "1",
                 "description": "1",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -35,6 +36,7 @@
                 "ariaLabel": 2,
                 "label": "2",
                 "description": "2",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -62,6 +64,7 @@
                     "ariaLabel": 3,
                     "label": "3",
                     "description": "3",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -81,6 +84,7 @@
                     "ariaLabel": 4,
                     "label": "4",
                     "description": "4",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -104,6 +108,7 @@
                 "ariaLabel": 5,
                 "label": "5",
                 "description": "5",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,

diff --git a/tests/testthat/_snaps/scoutbar/simple-002_.new.png b/tests/testthat/_snaps/scoutbar/simple-002_.new.png
diff --git a/tests/testthat/_snaps/scoutbar/simple-002_.png b/tests/testthat/_snaps/scoutbar/simple-002_.png
diff --git a/tests/testthat/_snaps/scoutbar/simple-003.json b/tests/testthat/_snaps/scoutbar/simple-003.json
@@ -16,6 +16,7 @@
                 "ariaLabel": 1,
                 "label": "1",
                 "description": "1",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -35,6 +36,7 @@
                 "ariaLabel": 2,
                 "label": "2",
                 "description": "2",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,
@@ -62,6 +64,7 @@
                     "ariaLabel": 3,
                     "label": "3",
                     "description": "3",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -81,6 +84,7 @@
                     "ariaLabel": 4,
                     "label": "4",
                     "description": "4",
+                    "closeOnClick": true,
                     "icon": {
                       "type": "i",
                       "key": null,
@@ -104,6 +108,7 @@
                 "ariaLabel": 5,
                 "label": "5",
                 "description": "5",
+                "closeOnClick": true,
                 "icon": {
                   "type": "i",
                   "key": null,