mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 07:28:01 -05:00
32f93a2be1
* Update roxygen and regenerate. Mostly just whitespace changes and `code` -> `verb`. * R6 documentation for MockShinySession * Install roxygen from GH * % are now auto-escaped (We still need to go find the rest) * Fixed the ramining \% in roxygen Found looking for ^#'.*\\% in all R files, so I believe this is all of them. * Regenerate docs * Decreate indent in roxygen so paragraphs don't get interpreted as code blocks. https://github.com/r-lib/roxygen2/issues/948#issuecomment-546386172 * Namespace * Add MockShinySession reference to pkgdown. * Clean up test warnings * Export session
76 lines
2.3 KiB
R
76 lines
2.3 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/bookmark-state.R
|
|
\name{bookmarkButton}
|
|
\alias{bookmarkButton}
|
|
\title{Create a button for bookmarking/sharing}
|
|
\usage{
|
|
bookmarkButton(
|
|
label = "Bookmark...",
|
|
icon = shiny::icon("link", lib = "glyphicon"),
|
|
title = "Bookmark this application's state and get a URL for sharing.",
|
|
...,
|
|
id = "._bookmark_"
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{label}{The contents of the button or link--usually a text label, but
|
|
you could also use any other HTML, like an image.}
|
|
|
|
\item{icon}{An optional \code{\link[=icon]{icon()}} to appear on the button.}
|
|
|
|
\item{title}{A tooltip that is shown when the mouse cursor hovers over the
|
|
button.}
|
|
|
|
\item{...}{Named attributes to be applied to the button or link.}
|
|
|
|
\item{id}{An ID for the bookmark button. The only time it is necessary to set
|
|
the ID unless you have more than one bookmark button in your application.
|
|
If you specify an input ID, it should be excluded from bookmarking with
|
|
\code{\link[=setBookmarkExclude]{setBookmarkExclude()}}, and you must create an observer that
|
|
does the bookmarking when the button is pressed. See the examples below.}
|
|
}
|
|
\description{
|
|
A \code{bookmarkButton} is a \code{\link[=actionButton]{actionButton()}} with a default label
|
|
that consists of a link icon and the text "Bookmark...". It is meant to be
|
|
used for bookmarking state.
|
|
}
|
|
\examples{
|
|
## Only run these examples in interactive sessions
|
|
if (interactive()) {
|
|
|
|
# This example shows how to use multiple bookmark buttons. If you only need
|
|
# a single bookmark button, see examples in ?enableBookmarking.
|
|
ui <- function(request) {
|
|
fluidPage(
|
|
tabsetPanel(id = "tabs",
|
|
tabPanel("One",
|
|
checkboxInput("chk1", "Checkbox 1"),
|
|
bookmarkButton(id = "bookmark1")
|
|
),
|
|
tabPanel("Two",
|
|
checkboxInput("chk2", "Checkbox 2"),
|
|
bookmarkButton(id = "bookmark2")
|
|
)
|
|
)
|
|
)
|
|
}
|
|
server <- function(input, output, session) {
|
|
# Need to exclude the buttons from themselves being bookmarked
|
|
setBookmarkExclude(c("bookmark1", "bookmark2"))
|
|
|
|
# Trigger bookmarking with either button
|
|
observeEvent(input$bookmark1, {
|
|
session$doBookmark()
|
|
})
|
|
observeEvent(input$bookmark2, {
|
|
session$doBookmark()
|
|
})
|
|
}
|
|
enableBookmarking(store = "url")
|
|
shinyApp(ui, server)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[=enableBookmarking]{enableBookmarking()}} for more examples.
|
|
}
|