add reactRouterExample()

Author: lgnbhl

NAMESPACE

@@ -13,6 +13,7 @@ export(Outlet)
 export(Route)
 export(Routes)
 export(reactRouterDependency)
+export(reactRouterExample)
 export(updateLink.shinyInput)
 export(updateNavLink.shinyInput)
 importFrom(shiny.react,JS)

R/reactRouterExample.R

@@ -0,0 +1,25 @@
+#' Run reactRouterExample example
+#'
+#' Launch a Shiny example app or list the available examples.
+#' Use `reactRouter::reactRouterExample("basic")` to run a showcase app.
+#'
+#' @param example The name of the example to run, or `NULL` to retrieve the list of examples.
+#' @param ... Additional arguments to pass to `shiny::runApp()`.
+#' @return This function normally does not return;
+#' interrupt R to stop the application (usually by pressing Ctrl+C or Esc).
+#'
+#' @seealso [shiny.blueprint::runExample()] which this function is an adaptation.
+#'
+#' @export
+reactRouterExample <- function(example = NULL, ...) {
+  examples <- system.file("examples", package = utils::packageName(), mustWork = TRUE)
+  if (is.null(example)) {
+    sub("\\.R$", "", list.files(examples))
+  } else {
+    path <- file.path(examples, example)
+    if (!grepl("\\.R$", path) && !file.exists(path)) {
+      path <- paste0(path, ".R")
+    }
+    shiny::runApp(path, ...)
+  }
+}

README.Rmd

@@ -40,13 +40,20 @@ HashRouter(
 
 ### Install
 
-``` r
+```r
 #remotes::install_github("lgnbhl/reactRouter") # development version
 
 install.packages("reactRouter")
 ```
 
-### More tutorials
+### Example
+
+Get started with a showcase example:
+
+```{r}
+# print all examples available: reactRouterExample()
+reactRouterExample("basic")
+```
 
 Read the vignette [here](https://felixluginbuhl.com/reactRouter/articles/introduction.html) for detailed use cases with Quarto and R Shiny.