From a79f9d59798369bd93bb08908d7cac3774c179a2 Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Thu, 23 Feb 2023 09:54:09 +0100 Subject: [PATCH] docs: Update documentation. --- man/router_ui.Rd | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/man/router_ui.Rd b/man/router_ui.Rd index 86c17df..84eda27 100644 --- a/man/router_ui.Rd +++ b/man/router_ui.Rd @@ -11,9 +11,10 @@ router_ui(default, ..., page_404 = page404(), env = parent.frame()) \item{...}{All other routes defined with shiny.router::route function.} -\item{page_404}{Styling of page when wrong bookmark is open. See \link{page404}.} +\item{page_404}{Styling of page when invalid route is open. See \link{page404}.} -\item{env}{Environment (only for advanced usage).} +\item{env}{Environment (only for advanced usage), makes it possible to use shiny.router inside +shiny modules.} } \value{ Application UI wrapped in a router. @@ -21,6 +22,10 @@ Application UI wrapped in a router. \description{ Creates router UI in Shiny applications. } +\details{ +If you are defining the router inside a shiny module, + we assume that the namespacing function defined in the UI is named as ns. +} \examples{ \dontrun{ ui <- function() {