Create a 'Close' Button to Exit the Survey

Usage

sd_close(
  label_close = NULL,
  label_previous = NULL,
  show_previous = NULL,
  show_restart = FALSE,
  label_restart = NULL,
  clear_cookies = FALSE
)

Arguments

label_close

Character string. The label of the 'Close' button. Defaults to NULL, in which case the word "Exit Survey" will be used.

label_previous

Character string. The label for the 'Previous' button. Defaults to NULL, which uses "← Previous" (or the translated equivalent).

show_previous

Logical. Whether to show the Previous button alongside the Close button. Set to TRUE to allow users to go back before closing. Defaults to FALSE. Note: Unlike sd_nav(), this parameter does NOT read from the show-previous YAML setting.

show_restart

Logical. Whether to show a 'Restart Survey' button alongside the Close button. When TRUE, displays two side-by-side buttons. Defaults to FALSE.

label_restart

Character string. The label for the 'Restart Survey' button. Defaults to NULL, which uses "Restart Survey" (or the translated equivalent).

clear_cookies

Logical. Whether to clear cookies on exit without showing a restart button. Use for use cases where the restart button isn't needed but cookies should be cleared for later resubmission. Defaults to FALSE.

Value

A 'shiny' tagList containing the 'Close' button UI element and associated JavaScript for the exit process.

Details

The function generates a 'shiny' action button that, when clicked, triggers the 'show_exit_modal' event. The server-side logic (controlled by the rate_survey parameter in sd_server()) determines whether to show a rating question or a simple confirmation dialog.

The function also includes a custom message handler for closing the window. This is necessary because some browsers may not allow JavaScript to close windows that were not opened by JavaScript. In such cases, the user will be prompted to close the tab manually.

Note

The actual behavior of the exit process (whether to show a rating question or not) is controlled by the rate_survey parameter in the sd_server() function, not in this UI function.

See also

Examples

if (interactive()) {
  library(surveydown)

  # Use sd_close() in survey.qmd on the last page:
  # --- end
  #
  # Thank you for completing the survey!
  #
  # `r sd_close(label_close = "Exit Survey", show_previous = TRUE)`

  # Find a working directory and start from a template:
  sd_create_survey(template = "default")
  # This creates survey.qmd and app.R - launch the survey using app.R
}