::: hack solution

Description

::: hack solution

Usage

pkg %:::% name

Arguments

Value

function

On Load

Description

On Load

Usage

.onAttach(libname, pkgname)

Arguments

Default 404 page

Description

This is default 404 page.

Usage

PAGE_404_ROUTE

Format

An object of class character of length 1.

Attach 'router-hidden' class to single page UI content

Description

Covered UI types are Shiny/htmltools tags or tag lists and html templates. In case of tag list (tagList) and html template (htmlTemplate) 'div' wrapper with 'router-hidden' class is added.

Usage

attach_attribs(ui, path)

Arguments

Create a mapping between a UI element and a server callback.

Description

Create a mapping between a UI element and a server callback.

Usage

callback_mapping(path, ui, server = NA)

Arguments

Value

list with ui and server fields

Change the currently displayed page.

Description

Works by sending a message up to our reactive input binding on the client side, which tells page.js to update the window URL accordingly, then tells client side shiny that our reactive input binding has changed, then that comes back down to our router callback function and all other observers watching get_page() or similar.

Usage

change_page(page, session = shiny::getDefaultReactiveDomain(), mode = "push")

Arguments

Formats a URL fragment into a hash path starting with "#!/"

Description

Formats a URL fragment into a hash path starting with "#!/"

Usage

cleanup_hashpath(hashpath)

Arguments

Value

character with formatted hash path

Internal function creating a router callback function. One need to call router callback with Shiny input and output in server code.

Description

Internal function creating a router callback function. One need to call router callback with Shiny input and output in server code.

Usage

create_router_callback(root, routes = NULL)

Arguments

Value

Router callback.

Fix conflicts when some bookmark uses bootstrap

Description

This function dynamically removes bootstrap dependency when user opens specified bookmark. It should be inserted in head of bootstrap page.

Usage

disable_bootstrap_on_bookmark(bookmark)

Arguments

Extract link name

Description

Strips off the first 3 character, assuming that they are: "#!/".

Usage

extract_link_name(path)

Arguments

Value

stripped link

Convenience function to retrieve just the "page" part of the input.

Description

This corresponds to what might be called the "path" component of a URL, except that we're using URLs with hashes before the path & query (e.g.: http://www.example.com/#!/virtual/path?and=params)

Usage

get_page(session = shiny::getDefaultReactiveDomain())

Arguments

Value

The current page in a length-1 character vector, or FALSE if the input has no value.

Get Query Parameters

Description

Convenience function to retrieve any params that were part of the requested page. The param values returned come from "httr::parse_url()"

Usage

get_query_param(field = NULL, session = shiny::getDefaultReactiveDomain())

Arguments

Value

The full list of params on the URL (if any), as a list. Or, the single requested param (if present). Or NULL if there's no input, or no params.

Internal function to get url hash with #!.

Description

Internal function to get url hash with #!.

Usage

get_url_hash(session = shiny::getDefaultReactiveDomain())

Arguments

Value

Reactive hash value.

Is page

Description

Tell the reactive chain to halt if we're not on the specified page. Useful for making sure we don't waste cycles re-rendering the UI for pages that are not currently displayed.

Usage

is_page(page, session = shiny::getDefaultReactiveDomain(), ...)

Arguments

Helper function to print out log messages into Shiny using cat() and stderr(), as described on https://shiny.rstudio.com/articles/debugging.html

Description

Because this can print a lot, it's silent unless the shiny.router.debug option is set.

Usage

log_msg(...)

Arguments

[Deprecated] Creates router.

Description

Returned callback needs to be called within Shiny server code.

Usage

make_router(default, ..., page_404 = page404())

Arguments

Value

Shiny router callback that should be run in server code with Shiny input and output lists.

Examples

## Not run: 
router <- make_router(
  route("/", root_page),
  route("/other", other_page),
  page_404 = page404(
    message404 = "Please check if you passed correct bookmark name!")
)

## End(Not run)

404 page

Description

The page which appear when path is wrong.

Usage

page404(page = NULL, message404 = NULL)

Arguments

Examples

page404() # shiny::tags$div(h1("Not found"))
page404(message404 = "ABC") # shiny::tags$div(h1("ABC"))

Parse url and build GET parameters list

Description

Extract info about url path and parameters that follow ? sign.

Usage

parse_url_path(url_path)

Arguments

Details

parse_url_path allows parsing parameters lists from url. See more in examples.

Note that having query string appear before #! may cause browser to refresh and thus reset Shiny session.

Value

list containing two objects:

• path

• query, a list

Examples

parse_url_path("?a=1&b=foo")
parse_url_path("?a=1&b[1]=foo&b[2]=bar/#!/")
parse_url_path("?a=1&b[1]=foo&b[2]=bar/#!/other_page")
parse_url_path("www.foo.bar/#!/other_page")
parse_url_path("www.foo.bar?a=1&b[1]=foo&b[2]=bar/#!/other")
parse_url_path("#!/?a=1&b[1]=foo&b[2]=bar")
parse_url_path("#!/other_page?a=1&b[1]=foo&b[2]=bar")
parse_url_path("www.foo.bar/#!/other?a=1&b[1]=foo&b[2]=bar")

Create single route configuration.

Description

Create single route configuration.

Usage

route(path, ui, server = NA)

Arguments

Value

A route configuration.

Examples

## Not run: 
route("/", shiny::tags$div(shiny::tags$span("Hello world")))

route("main", shiny::tags$div(h1("Main page"), p("Lorem ipsum.")))

## End(Not run)

Route link

Description

Adds /#!/ prefix to link.

Usage

route_link(path)

Arguments

Value

route link

Examples

route_link("abc") # /#!/abc

Create router pages server callback

Description

Server part of the router.

Usage

router_server(root_page = "/", env = parent.frame())

Arguments

Value

Router pages server callback.

Examples

## Not run: 
  server <- function(input, output, session) {
    router_server(root_page = "/")
  }

## End(Not run)

Create router pages server callback

Description

Create router pages server callback

Usage

router_server_internal(router)

Arguments

Create router UI

Description

Creates router UI in Shiny applications.

Usage

router_ui(default, ..., page_404 = page404(), env = parent.frame())

Arguments

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.

Value

Application UI wrapped in a router.

Examples

## Not run: 
  ui <- function() {
    router_ui(
      route("/", root_page(id = "root")),
      route("other", other_page(id = "other")),
      page_404 = page404(
        message404 = "Please check if you passed correct bookmark name!")
    )
  }

## End(Not run)
## Not run: 
  # create the list of routes
  dynamic_routes <- list(
    route("other2", other_page(id = "other2")),
    route("other3", other_page(id = "other3"))
  )

  ui <- function() {
    router_ui(
      route("/", root_page(id = "root")),
      route("other", other_page(id = "other")),
      # then it's possible to inject a list of arguments into a function call using rlang::`!!!`
      !!!dynamic_routes,
      page_404 = page404(
        message404 = "Please check if you passed correct bookmark name!")
    )
  }

## End(Not run)

Creates router UI

Description

Creates router UI

Usage

router_ui_internal(router)

Arguments

Value

list with shiny tags that adds "router-page-wrapper" div and embeds router JavaScript script.

Internal function that validates that path is defined in routes.

Description

Internal function that validates that path is defined in routes.

Usage

valid_path(routes, path)

Arguments

Value

Boolean value indicating if path is defined.