mirror of
https://github.com/rstudio/shiny.git
synced 2026-02-06 20:55:24 -05:00
36 lines
1.2 KiB
R
36 lines
1.2 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/save-state.R
|
|
\name{configureBookmarking}
|
|
\alias{configureBookmarking}
|
|
\title{Configure bookmarking for the current session}
|
|
\usage{
|
|
configureBookmarking(eventExpr, type = c("encode", "persist", "disable"),
|
|
exclude = NULL, onBookmark = NULL, onRestore = NULL,
|
|
onBookmarked = NULL, session = getDefaultReactiveDomain())
|
|
}
|
|
\arguments{
|
|
\item{eventExpr}{An expression to listen for, similar to
|
|
\code{\link{observeEvent}}.}
|
|
|
|
\item{type}{Either \code{"encode"}, which encodes all of the relevant values
|
|
in a URL, \code{"persist"}, which saves to disk, or \code{"disable"}, which
|
|
disables any previously-enabled bookmarking.}
|
|
|
|
\item{exclude}{Input values to exclude from bookmarking.}
|
|
|
|
\item{onBookmark}{A function to call before saving state. This function
|
|
should return a list, which will be saved as \code{values}.}
|
|
|
|
\item{onRestore}{A function to call when a session is restored. It will be
|
|
passed one argument, a restoreContext object.}
|
|
|
|
\item{onBookmarked}{A callback function to invoke after the bookmarking has
|
|
been done.}
|
|
|
|
\item{session}{A Shiny session object.}
|
|
}
|
|
\description{
|
|
There are two types of bookmarking: saving state, and encoding state.
|
|
}
|
|
|