Export the user facing function and update changelog (#1022)

Closes #1018 for real --------- Signed-off-by: Vedha Viyash <[email protected]> Co-authored-by: Aleksander Chlebowski <[email protected]>
insightsengineering · Jan 5, 2024 · 9a0dd55 · 9a0dd55
1 parent a323682
commit 9a0dd55
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -19,6 +19,7 @@ export("%>%")
 export(TealReportCard)
 export(as.teal_slices)
 export(as_tdata)
+export(build_app_title)
 export(example_module)
 export(get_code_tdata)
 export(get_metadata)

diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,7 @@
 * Added `landing_popup_module` function which creates a module that will display a popup when the app starts. The popup will block access to the app until it is dismissed.
 * Filter state snapshots can now be uploaded from file. See `?snapshot`.
 * Added `as_tdata` function to facilitate migration of modules to the new `teal_data` class.
+* Added `build_app_title` function to facilitate adding favicons to app title.
 
 ### Breaking changes
 

diff --git a/R/utils.R b/R/utils.R
@@ -258,6 +258,7 @@ validate_app_title_tag <- function(shiny_tag) {
 #' The image/icon path can be remote or the static path accessible by shiny, like the `www/`
 #'
 #' @return A `shiny.tag` containing the element that adds the title and logo to the shiny app
+#' @export
 build_app_title <- function(title = "Teal app", favicon = "https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/nest.png") { # nolint
   checkmate::assert_string(title, null.ok = TRUE)
   checkmate::assert_string(favicon, null.ok = TRUE)