update

Author: Tazinho

R/dependencies.R

@@ -6,7 +6,7 @@
 #' @return An [htmltools::htmlDependency] for SurveyJS v2.2.6
 #' @importFrom htmltools htmlDependency
 #' @keywords internal
-#’ @noRd
+#' @noRd
 dep_react <- function() {
   htmltools::htmlDependency(
     name = "react",
@@ -22,7 +22,7 @@ dep_react <- function() {
 #' @return An [htmltools::htmlDependency] for SurveyJS v2.2.6
 #' @importFrom htmltools htmlDependency
 #' @keywords internal
-#’ @noRd
+#' @noRd
 dep_reactdom <- function() {
   htmltools::htmlDependency(
     name = "react-dom",
@@ -38,7 +38,7 @@ dep_reactdom <- function() {
 #' @return An [htmltools::htmlDependency] for SurveyJS v2.2.6
 #' @importFrom htmltools htmlDependency
 #' @keywords internal
-#’ @noRd
+#' @noRd
 dep_surveyjs_core <- function() {
   htmltools::htmlDependency(
     name = "surveyjs", version = "2.2.6",

R/surveyjs.R

@@ -12,48 +12,57 @@
 #' @param schema List or JSON string; must follow
 #'   [SurveyJS JSON Schema](https://surveyjs.io/form-library/documentation/json-schema).
 #' @param data Initial values.
-#' @param readOnly Render in read-only mode.
+#' @param read_only Render in read-only mode.
 #' @param live Live update responses?
 #' @param theme Theme name.
 #' @param theme_vars Named list of CSS variables (e.g. `--sjs-primary-backcolor`).
 #' @param locale Language code (e.g. `"en"`, `"de"`)
-#' @param width,height Optional CSS size or number.
-#' @param elementId Optional element id for the container.
 #' @param pre_render_hook JavaScript code (as a string) to run before rendering the survey.
 #'   Supply only the body of a JavaScript function — do not wrap it in `function(...) {}`.
 #' @param post_render_hook JavaScript code (as a string) to run after the survey is rendered.
 #'   Also supply only the body of a JavaScript function — not a full `function(...) {}` wrapper.
-#' @param width,height Optional size specs.
-#' @param elementId Optional element id for the container.
+#' @param complete_hook JavaScript function body to run on survey completion
+#' @param width,height Optional CSS size or number.
+#' @param element_id Optional element ID. Leave NULL in Shiny (it's auto-assigned).
+#' @details
+#' The SurveyJS widget is responsive by default. The `resize()` method is a placeholder
+#' and does not implement manual resizing logic, as SurveyJS adapts to container size
+#' via CSS flexbox rules.
 #' @export
-surveyjs <- function(schema, data = NULL, readOnly = FALSE, live = FALSE,
-                       theme = "DefaultLight", theme_vars = NULL, locale = NULL,
-                       pre_render_hook = NULL, post_render_hook = NULL,
-                       width = NULL, height = NULL, elementId = NULL) {
+surveyjs <- function(schema, data = NULL, read_only = FALSE, live = FALSE,
+                     theme = "DefaultLight", theme_vars = NULL, locale = NULL,
+                     pre_render_hook = NULL, post_render_hook = NULL,
+                     complete_hook = NULL, width = NULL, height = NULL,
+                     element_id = NULL) {
 
-    schema_json <- if (is.character(schema)) schema
-    else jsonlite::toJSON(schema, auto_unbox = TRUE)
+  if (shiny::isRunning() && !is.null(element_id)) {
+    warning("In Shiny, `element_id` is ignored. The widget ID is automatically set from the output ID in `surveyjsOutput(id)`.")
+  }
 
+  schema_json <- if (is.character(schema)) schema
+  else jsonlite::toJSON(schema, auto_unbox = TRUE)
 
   x <- list(
     schema            = schema_json,
     data              = data,
-    readOnly          = readOnly,
+    read_only         = read_only,
     live              = live,
     theme             = theme,
     theme_vars        = theme_vars,
     locale            = locale,
     pre_render_hook   = pre_render_hook,
-    post_render_hook  = post_render_hook
+    post_render_hook  = post_render_hook,
+    complete_hook     = complete_hook,
+    element_id        = element_id
   )
 
   htmlwidgets::createWidget(
     name = "surveyjs",
     x = x,
     width = width,
     height = height,
+    elementId = element_id,
     package = "rsurveyjs",
-    elementId = elementId,
     dependencies = list(
       dep_react(),
       dep_reactdom(),

R/update.R

@@ -7,7 +7,7 @@
 #' @param session Shiny session object.
 #' @param id Output ID used in `surveyjsOutput()`.
 #' @param data Optional named list of answers to set.
-#' @param readOnly Optional logical; toggle read-only mode.
+#' @param read_only Optional logical; toggle read-only mode.
 #' @param schema Optional new schema (list or JSON string).
 #' @param theme Optional theme name (e.g. `"modern"`).
 #' @param locale Optional locale code (e.g. `"en"`, `"de"`).
@@ -20,19 +20,22 @@
 #'
 #' @export
 updateSurveyjs <- function(session, id,
-                           data     = NULL,
-                           readOnly = NULL,
-                           schema   = NULL,
-                           theme    = NULL,
-                           locale   = NULL) {
+                           data = NULL, read_only = NULL, schema = NULL,
+                           theme = NULL, locale = NULL) {
 
-  payload <- list(
-    id = id,
-    data = data,
-    readOnly = readOnly,
-    schema = if (!is.null(schema)) if (is.character(schema)) schema else jsonlite::toJSON(schema, auto_unbox = TRUE),
-    theme  = theme,
-    locale = locale
-  )
-  session$sendCustomMessage("rsurveyjs:update", payload)
+  if (!is.null(data)) {
+    session$sendCustomMessage("surveyjs-data", list(el = id, data = data))
+  }
+  if (!is.null(read_only)) {
+    session$sendCustomMessage("surveyjs-mode", list(el = id, mode = if (read_only) "display" else "edit"))
+  }
+  if (!is.null(schema)) {
+    session$sendCustomMessage("surveyjs-schema", list(el = id, schema = schema))
+  }
+  if (!is.null(theme)) {
+    session$sendCustomMessage("surveyjs-theme", list(el = id, theme = theme))
+  }
+  if (!is.null(locale)) {
+    session$sendCustomMessage("surveyjs-locale", list(el = id, locale = locale))
+  }
 }

README.Rmd

@@ -144,24 +144,22 @@ This avoids applying potentially mismatched styles and helps keep behavior predi
 
 ## Known limitations so far
 
-* consistent argument naming e.g. theme_vars vs readOnly...> snake_case
-* work over vignettes (including editing, consistency, cross-linking, examples)
-* does the high level structure for vignettes make sense?
-* what are multi-locale surveys?
-* switch language on runtime (e.g. via dropown; supproted by surveyjs) (could add a message handler like "surveyjs-locale" - not yet done)
 * Live results tracking example doesnt work yet > work with onValueChanged > Shiny.setInputValue(...)
 * Completion example does not work or is not meaningful > Covered by onComplete + input&<id>_data
 * Dynamic Update example does not work or is not meaningful
-* tests/unit tests for all examples are needed
 * error handling
-* Embedding in other widgets or layouts
-* Extending with custom question types
-* Custom widgets / question renderers (needs js-level support, potentially surveyjs plugin, not sure if possible)
 * Provide file upload example - e.g. what to do then with that file?
 * provide a shiny database example including testing with db-connection
 
-* In surveyjs.js den Comment noch auflösen. You can add resizing suppert here if needed later
+* Custom widgets / question renderers (needs js-level support, potentially surveyjs plugin, not sure if possible)
+* Extending with custom question types
+* Embedding in other widgets or layouts
+* tests/unit tests for all examples are needed
+* switch language on runtime (e.g. via dropown; supproted by surveyjs) (could add a message handler like "surveyjs-locale" - not yet done)
+* what are multi-locale surveys?
+* does the high level structure for vignettes make sense?
 * PDF/Excel/CSV/JSON Export
+* work over vignettes (including editing, consistency, cross-linking, examples)
 
 * DSLs e.g. surveyjs_text, surveyjs_number, .. to user friendly, standardizing, encourage best practices
 * validation utilities or DSLs like survejs_validator would output the correct pre_render_hook string for that validator, e.g.,
@@ -256,35 +254,35 @@ Shiny.addCustomMessageHandler("surveyjs-clear", function(message) {
   }
 });
 
-In R:
+<!-- In R: -->
 
-session$sendCustomMessage("surveyjs-clear", list(el = "survey_id"))
+<!-- session$sendCustomMessage("surveyjs-clear", list(el = "survey_id")) -->
 
-✅ Events to Add for Shiny Interop
-Event	Purpose	When to Use
-onComplete	Send results to Shiny when survey is done	Capture responses in server
-onValueChanged	Live-update an input binding	Track form progress reactively
-Example: Live updates
+<!-- ✅ Events to Add for Shiny Interop -->
+<!-- Event	Purpose	When to Use -->
+<!-- onComplete	Send results to Shiny when survey is done	Capture responses in server -->
+<!-- onValueChanged	Live-update an input binding	Track form progress reactively -->
+<!-- Example: Live updates -->
 
-survey.onValueChanged.add(function(sender, options) {
-  Shiny.setInputValue(el.id + "_data_live", sender.data, { priority: "event" });
-});
+<!-- survey.onValueChanged.add(function(sender, options) { -->
+<!--   Shiny.setInputValue(el.id + "_data_live", sender.data, { priority: "event" }); -->
+<!-- }); -->
 
-And final submission:
+<!-- And final submission: -->
 
-survey.onComplete.add(function(sender) {
-  Shiny.setInputValue(el.id + "_data", sender.data);
-});
+<!-- survey.onComplete.add(function(sender) { -->
+<!--   Shiny.setInputValue(el.id + "_data", sender.data); -->
+<!-- }); -->
 
-Then in R:
+<!-- Then in R: -->
 
-input$survey_id_data      # final completed data
-input$survey_id_data_live # updated continuously
+<!-- input$survey_id_data      # final completed data -->
+<!-- input$survey_id_data_live # updated continuously -->
 
 
-    onComplete, onValueChanged
+    <!-- onComplete, onValueChanged -->
 
-    Maybe nextPage()/prevPage() for custom buttons
+    <!-- Maybe nextPage()/prevPage() for custom buttons -->
 
 
 ---

README.md

@@ -161,18 +161,6 @@ behavior predictable.
 
 ## Known limitations so far
 
-- consistent argument naming e.g. theme_vars vs readOnly…\> snake_case
-
-- work over vignettes (including editing, consistency, cross-linking,
-  examples)
-
-- does the high level structure for vignettes make sense?
-
-- what are multi-locale surveys?
-
-- switch language on runtime (e.g. via dropown; supproted by surveyjs)
-  (could add a message handler like “surveyjs-locale” - not yet done)
-
 - Live results tracking example doesnt work yet \> work with
   onValueChanged \> Shiny.setInputValue(…)
 
@@ -181,26 +169,33 @@ behavior predictable.
 
 - Dynamic Update example does not work or is not meaningful
 
-- tests/unit tests for all examples are needed
-
 - error handling
 
-- Embedding in other widgets or layouts
+- Provide file upload example - e.g. what to do then with that file?
 
-- Extending with custom question types
+- provide a shiny database example including testing with db-connection
 
 - Custom widgets / question renderers (needs js-level support,
   potentially surveyjs plugin, not sure if possible)
 
-- Provide file upload example - e.g. what to do then with that file?
+- Extending with custom question types
 
-- provide a shiny database example including testing with db-connection
+- Embedding in other widgets or layouts
 
-- In surveyjs.js den Comment noch auflösen. You can add resizing suppert
-  here if needed later
+- tests/unit tests for all examples are needed
+
+- switch language on runtime (e.g. via dropown; supproted by surveyjs)
+  (could add a message handler like “surveyjs-locale” - not yet done)
+
+- what are multi-locale surveys?
+
+- does the high level structure for vignettes make sense?
 
 - PDF/Excel/CSV/JSON Export
 
+- work over vignettes (including editing, consistency, cross-linking,
+  examples)
+
 - DSLs e.g. surveyjs_text, surveyjs_number, .. to user friendly,
   standardizing, encourage best practices
 
@@ -294,32 +289,43 @@ Shiny.addCustomMessageHandler(“surveyjs-clear”, function(message) {
 const el = document.getElementById(message.el); if (el &&
 el.surveyModel) { el.surveyModel.clear(); } });
 
-In R:
+<!-- In R: -->
 
-session\$sendCustomMessage(“surveyjs-clear”, list(el = “survey_id”))
+<!-- session$sendCustomMessage("surveyjs-clear", list(el = "survey_id")) -->
 
-✅ Events to Add for Shiny Interop Event Purpose When to Use onComplete
-Send results to Shiny when survey is done Capture responses in server
-onValueChanged Live-update an input binding Track form progress
-reactively Example: Live updates
+<!-- ✅ Events to Add for Shiny Interop -->
 
-survey.onValueChanged.add(function(sender, options) {
-Shiny.setInputValue(el.id + “\_data_live”, sender.data, { priority:
-“event” }); });
+<!-- Event  Purpose When to Use -->
 
-And final submission:
+<!-- onComplete Send results to Shiny when survey is done   Capture responses in server -->
 
-survey.onComplete.add(function(sender) { Shiny.setInputValue(el.id +
-“\_data”, sender.data); });
+<!-- onValueChanged Live-update an input binding    Track form progress reactively -->
+
+<!-- Example: Live updates -->
+
+<!-- survey.onValueChanged.add(function(sender, options) { -->
+
+<!--   Shiny.setInputValue(el.id + "_data_live", sender.data, { priority: "event" }); -->
+
+<!-- }); -->
+
+<!-- And final submission: -->
+
+<!-- survey.onComplete.add(function(sender) { -->
+
+<!--   Shiny.setInputValue(el.id + "_data", sender.data); -->
+
+<!-- }); -->
+
+<!-- Then in R: -->
 
-Then in R:
+<!-- input$survey_id_data      # final completed data -->
 
-input$survey_id_data      # final completed data
-input$survey_id_data_live \# updated continuously
+<!-- input$survey_id_data_live # updated continuously -->
 
-    onComplete, onValueChanged
+    <!-- onComplete, onValueChanged -->
 
-    Maybe nextPage()/prevPage() for custom buttons
+    <!-- Maybe nextPage()/prevPage() for custom buttons -->
 
 ------------------------------------------------------------------------