mirror of
https://github.com/rstudio/shiny.git
synced 2026-02-07 05:04:58 -05:00
102 lines
3.3 KiB
R
102 lines
3.3 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/bookmark-state.R
|
|
\name{updateQueryString}
|
|
\alias{updateQueryString}
|
|
\title{Update URL in browser's location bar}
|
|
\usage{
|
|
updateQueryString(queryString, mode = c("replace", "push"),
|
|
session = getDefaultReactiveDomain())
|
|
}
|
|
\arguments{
|
|
\item{queryString}{The new query string to show in the location bar.}
|
|
|
|
\item{mode}{When the query string is updated, should the the current history
|
|
entry be replaced (default), or should a new history entry be pushed onto
|
|
the history stack? The former should only be used in a live bookmarking
|
|
context. The latter is useful if you want to navigate between states using
|
|
the browser's back and forward buttons. See Examples.}
|
|
|
|
\item{session}{A Shiny session object.}
|
|
}
|
|
\description{
|
|
This function updates the client browser's query string in the location bar.
|
|
It typically is called from an observer. Note that this will not work in
|
|
Internet Explorer 9 and below.
|
|
}
|
|
\details{
|
|
For \code{mode = "push"}, only three updates are currently allowed:
|
|
\enumerate{
|
|
\item the query string (format: \code{?param1=val1¶m2=val2})
|
|
\item the hash (format: \code{#hash})
|
|
\item both the query string and the hash
|
|
(format: \code{?param1=val1¶m2=val2#hash})
|
|
}
|
|
|
|
In other words, if \code{mode = "push"}, the \code{queryString} must start
|
|
with either \code{?} or with \code{#}.
|
|
|
|
A technical curiosity: under the hood, this function is calling the HTML5
|
|
history API (which is where the names for the \code{mode} argument come from).
|
|
When \code{mode = "replace"}, the function called is
|
|
\code{window.history.replaceState(null, null, queryString)}.
|
|
When \code{mode = "push"}, the function called is
|
|
\code{window.history.pushState(null, null, queryString)}.
|
|
}
|
|
\examples{
|
|
## Only run these examples in interactive sessions
|
|
if (interactive()) {
|
|
|
|
## App 1: Doing "live" bookmarking
|
|
## Update the browser's location bar every time an input changes.
|
|
## This should not be used with enableBookmarking("server"),
|
|
## because that would create a new saved state on disk every time
|
|
## the user changes an input.
|
|
enableBookmarking("url")
|
|
shinyApp(
|
|
ui = function(req) {
|
|
fluidPage(
|
|
textInput("txt", "Text"),
|
|
checkboxInput("chk", "Checkbox")
|
|
)
|
|
},
|
|
server = function(input, output, session) {
|
|
observe({
|
|
# Trigger this observer every time an input changes
|
|
reactiveValuesToList(input)
|
|
session$doBookmark()
|
|
})
|
|
onBookmarked(function(url) {
|
|
updateQueryString(url)
|
|
})
|
|
}
|
|
)
|
|
|
|
## App 2: Printing the value of the query string
|
|
## (Use the back and forward buttons to see how the browser
|
|
## keeps a record of each state)
|
|
shinyApp(
|
|
ui = fluidPage(
|
|
textInput("txt", "Enter new query string"),
|
|
helpText("Format: ?param1=val1¶m2=val2"),
|
|
actionButton("go", "Update"),
|
|
hr(),
|
|
verbatimTextOutput("query")
|
|
),
|
|
server = function(input, output, session) {
|
|
observeEvent(input$go, {
|
|
updateQueryString(input$txt, mode = "push")
|
|
})
|
|
output$query <- renderText({
|
|
query <- getQueryString()
|
|
queryText <- paste(names(query), query,
|
|
sep = "=", collapse=", ")
|
|
paste("Your query string is:\\n", queryText)
|
|
})
|
|
}
|
|
)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link{enableBookmarking}}, \code{\link{getQueryString}}
|
|
}
|