Add teal app modifiers and deprecate init args

.pre-commit-config.yaml

@@ -20,6 +20,7 @@ repos:
           - mirai
           - checkmate
           - cli
+          - htmltools
           - jsonlite
           - lifecycle
           - logger

DESCRIPTION

@@ -35,13 +35,14 @@ URL: https://insightsengineering.github.io/teal/,
     https://github.com/insightsengineering/teal/
 BugReports: https://github.com/insightsengineering/teal/issues
 Depends:
-    R (>= 4.0),
+    R (>= 4.1),
     shiny (>= 1.8.1),
     teal.data (>= 0.6.0.9017),
     teal.slice (>= 0.5.1.9015)
 Imports:
     checkmate (>= 2.1.0),
     cli,
+    htmltools,
     jsonlite,
     lifecycle (>= 0.2.0),
     logger (>= 0.2.0),
@@ -84,7 +85,7 @@ Config/Needs/verdepcheck: rstudio/shiny, insightsengineering/teal.data,
     rstudio/bslib, yihui/knitr, bioc::MultiAssayExperiment, r-lib/R6,
     rstudio/rmarkdown, tidyverse/rvest, rstudio/shinytest2,
     rstudio/shinyvalidate, r-lib/testthat, r-lib/withr,
-    yaml=vubiostat/r-yaml
+    yaml=vubiostat/r-yaml, rstudio/htmltools
 Config/Needs/website: insightsengineering/nesttemplate
 Encoding: UTF-8
 Language: en-US
@@ -106,6 +107,7 @@ Collate:
     'module_filter_manager.R'
     'module_init_data.R'
     'module_nested_tabs.R'
+    'module_session_info.R'
     'module_snapshot_manager.R'
     'module_teal.R'
     'module_teal_data.R'
@@ -120,6 +122,7 @@ Collate:
     'teal_data_module-eval_code.R'
     'teal_data_module-within.R'
     'teal_data_utils.R'
+    'teal_modifiers.R'
     'teal_reporter.R'
     'teal_slices-store.R'
     'teal_slices.R'

NAMESPACE

@@ -14,6 +14,7 @@ S3method(ui_teal_module,teal_module)
 S3method(ui_teal_module,teal_modules)
 S3method(within,teal_data_module)
 export(TealReportCard)
+export(add_landing_modal)
 export(as.teal_slices)
 export(as_tdata)
 export(build_app_title)
@@ -23,19 +24,24 @@ export(get_metadata)
 export(init)
 export(landing_popup_module)
 export(make_teal_transform_server)
+export(modify_footer)
+export(modify_header)
+export(modify_title)
 export(module)
 export(modules)
 export(new_tdata)
 export(report_card_template)
 export(reporter_previewer_module)
 export(show_rcode_modal)
+export(srv_session_info)
 export(srv_teal)
 export(srv_teal_with_splash)
 export(srv_transform_teal_data)
 export(tdata2env)
 export(teal_data_module)
 export(teal_slices)
 export(teal_transform_module)
+export(ui_session_info)
 export(ui_teal)
 export(ui_teal_with_splash)
 export(ui_transform_teal_data)

NEWS.md

@@ -4,18 +4,22 @@
 
 * Possible to call `ui_teal` and `srv_teal` directly in any application by delivering `data` argument as a `reactive` returning `teal_data` object. #669
 * Since introduction of `ui_teal` and `srv_teal` functions `id` argument in `init` is being deprecated. #1438
+* Introduce `ui_session_info` and `srv_session_info` shiny module to create the user session info and teal app lockfile lockfile download button.
 * Introduced `teal_transform_module` to provide a way to interactively modify data delivered to `teal_module`'s `server` and to decorate module outputs. #1228 #1384
 * Introduced a new argument `once = FALSE` in `teal_data_module` to possibly reload data during a run time.
 * Possibility to download lockfile to restore app session for reproducibility. #479
 * Datasets which name starts with `.` are ignored when `module`'s `datanames` is set as `"all"`.
 * Added warning when reserved `datanames`, such as `all` and `.raw_data` are being used. 
+* Added `add_custom_server()` to allow adding custom server logic to the main shiny server function of a teal app.
 
 ### Breaking changes
 
 * Setting `datanames()` on `data` passed to teal application no longer has effect. In order to change `teal_module`'s 
 `datanames` one should modify `module$datanames`.
-* The `landing_popup_module()` needs to be passed as the `landing_popup` argument of `init` instead of being passed as a module of the `modules` argument of `init`.
+* `landing_popup_module()` is deprecated. Please use `add_landing_modal()` function to add a landing popup for your teal application.
 * `teal` no longer re-export `%>%`. Please load `library(magrittr)` instead or use `|>` from `base`.
+* `build_app_title` will be removed in the future release. Please use the `modify_title()` function to change the title for your teal application.
+* The `title`, `header`, and `footer` arguments of the `init()` function are deprecated. Please use the `modify_title`, `modify_header`, and `modify_footer` respectively.
 
 ### Enhancement
 

R/TealAppDriver.R

@@ -26,7 +26,8 @@ TealAppDriver <- R6::R6Class( # nolint: object_name.
     #' @description
     #' Initialize a `TealAppDriver` object for testing a `teal` application.
     #'
-    #' @param data,modules,filter,title,header,footer,landing_popup arguments passed to `init`
+    #' @param data,modules,filter arguments passed to `init`
+    #' @param title_args,header,footer,landing_popup_args to pass into the modifier functions.
     #' @param timeout (`numeric`) Default number of milliseconds for any timeout or
     #' timeout_ parameter in the `TealAppDriver` class.
     #' Defaults to 20s.
@@ -45,25 +46,51 @@ TealAppDriver <- R6::R6Class( # nolint: object_name.
     initialize = function(data,
                           modules,
                           filter = teal_slices(),
-                          title = build_app_title(),
+                          title_args = list(),
                           header = tags$p(),
                           footer = tags$p(),
-                          landing_popup = NULL,
+                          landing_popup_args = NULL,
                           timeout = rlang::missing_arg(),
                           load_timeout = rlang::missing_arg(),
                           ...) {
       private$data <- data
       private$modules <- modules
       private$filter <- filter
+
+      new_title <- modifyList(
+        list(
+          title = "Custom Teal App Title",
+          favicon = "https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/teal.png"
+        ),
+        title_args
+      )
       app <- init(
         data = data,
         modules = modules,
-        filter = filter,
-        title = title,
-        header = header,
-        footer = footer,
-        landing_popup = landing_popup,
-      )
+        filter = filter
+      ) |>
+        modify_title(title = new_title$title, favicon = new_title$favicon) |>
+        modify_header(header) |>
+        modify_footer(footer)
+
+      if (!is.null(landing_popup_args)) {
+        default_args <- list(
+          title = NULL,
+          content = NULL,
+          footer = modalButton("Accept")
+        )
+        landing_popup_args[names(default_args)] <- Map(
+          function(x, y) if (is.null(y)) x else y,
+          default_args,
+          landing_popup_args[names(default_args)]
+        )
+        app <- add_landing_modal(
+          app,
+          title = landing_popup_args$title,
+          content = landing_popup_args$content,
+          footer = landing_popup_args$footer
+        )
+      }
 
       # Default timeout is hardcoded to 4s in shinytest2:::resolve_timeout
       # It must be set as parameter to the AppDriver