mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
166 lines
13 KiB
HTML
166 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Create a button for bookmarking/sharing — bookmarkButton • shiny</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Create a button for bookmarking/sharing — bookmarkButton"><meta property="og:description" content='A bookmarkButton is a actionButton() with a default label
|
||
that consists of a link icon and the text "Bookmark...". It is meant to be
|
||
used for bookmarking state.'><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||
<![endif]--></head><body data-spy="scroll" data-target="#toc">
|
||
|
||
|
||
<div class="container template-reference-topic">
|
||
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<span class="navbar-brand">
|
||
<a class="navbar-link" href="../index.html">shiny</a>
|
||
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.12.1</span>
|
||
</span>
|
||
</div>
|
||
|
||
<div id="navbar" class="navbar-collapse collapse">
|
||
<ul class="nav navbar-nav"><li>
|
||
<a href="../reference/index.html">Reference</a>
|
||
</li>
|
||
<li>
|
||
<a href="../news/index.html">Changelog</a>
|
||
</li>
|
||
</ul><ul class="nav navbar-nav navbar-right"><li>
|
||
<a href="https://github.com/rstudio/shiny/" class="external-link">
|
||
<span class="fab fa-github fa-lg"></span>
|
||
|
||
</a>
|
||
</li>
|
||
</ul></div><!--/.nav-collapse -->
|
||
</div><!--/.container -->
|
||
</div><!--/.navbar -->
|
||
|
||
|
||
|
||
</header><div class="row">
|
||
<div class="col-md-9 contents">
|
||
<div class="page-header">
|
||
<h1>Create a button for bookmarking/sharing</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/rc-v1.12.1/R/bookmark-state.R" class="external-link"><code>R/bookmark-state.R</code></a></small>
|
||
<div class="hidden name"><code>bookmarkButton.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description">
|
||
<p>A <code>bookmarkButton</code> is a <code><a href="actionButton.html">actionButton()</a></code> with a default label
|
||
that consists of a link icon and the text "Bookmark...". It is meant to be
|
||
used for bookmarking state.</p>
|
||
</div>
|
||
|
||
<div id="ref-usage">
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">bookmarkButton</span><span class="op">(</span></span>
|
||
<span> label <span class="op">=</span> <span class="st">"Bookmark..."</span>,</span>
|
||
<span> icon <span class="op">=</span> <span class="fu">shiny</span><span class="fu">::</span><span class="fu"><a href="icon.html">icon</a></span><span class="op">(</span><span class="st">"link"</span>, lib <span class="op">=</span> <span class="st">"glyphicon"</span><span class="op">)</span>,</span>
|
||
<span> title <span class="op">=</span> <span class="st">"Bookmark this application's state and get a URL for sharing."</span>,</span>
|
||
<span> <span class="va">...</span>,</span>
|
||
<span> id <span class="op">=</span> <span class="st">"._bookmark_"</span></span>
|
||
<span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
|
||
<div id="arguments">
|
||
<h2>Arguments</h2>
|
||
|
||
|
||
<dl><dt id="arg-label">label<a class="anchor" aria-label="anchor" href="#arg-label"></a></dt>
|
||
<dd><p>The contents of the button or link–usually a text label, but
|
||
you could also use any other HTML, like an image.</p></dd>
|
||
|
||
|
||
<dt id="arg-icon">icon<a class="anchor" aria-label="anchor" href="#arg-icon"></a></dt>
|
||
<dd><p>An optional <code><a href="icon.html">icon()</a></code> to appear on the button.</p></dd>
|
||
|
||
|
||
<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
|
||
<dd><p>A tooltip that is shown when the mouse cursor hovers over the
|
||
button.</p></dd>
|
||
|
||
|
||
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
||
<dd><p>Named attributes to be applied to the button or link.</p></dd>
|
||
|
||
|
||
<dt id="arg-id">id<a class="anchor" aria-label="anchor" href="#arg-id"></a></dt>
|
||
<dd><p>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><a href="setBookmarkExclude.html">setBookmarkExclude()</a></code>, and you must create an observer that
|
||
does the bookmarking when the button is pressed. See the examples below.</p></dd>
|
||
|
||
</dl></div>
|
||
<div id="see-also">
|
||
<h2>See also</h2>
|
||
<div class="dont-index"><p><code><a href="enableBookmarking.html">enableBookmarking()</a></code> for more examples.</p></div>
|
||
</div>
|
||
|
||
<div id="ref-examples">
|
||
<h2>Examples</h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co">## Only run these examples in interactive sessions</span></span></span>
|
||
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># This example shows how to use multiple bookmark buttons. If you only need</span></span></span>
|
||
<span class="r-in"><span><span class="co"># a single bookmark button, see examples in ?enableBookmarking.</span></span></span>
|
||
<span class="r-in"><span><span class="va">ui</span> <span class="op"><-</span> <span class="kw">function</span><span class="op">(</span><span class="va">request</span><span class="op">)</span> <span class="op">{</span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="tabsetPanel.html">tabsetPanel</a></span><span class="op">(</span>id <span class="op">=</span> <span class="st">"tabs"</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="tabPanel.html">tabPanel</a></span><span class="op">(</span><span class="st">"One"</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="checkboxInput.html">checkboxInput</a></span><span class="op">(</span><span class="st">"chk1"</span>, <span class="st">"Checkbox 1"</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu">bookmarkButton</span><span class="op">(</span>id <span class="op">=</span> <span class="st">"bookmark1"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="tabPanel.html">tabPanel</a></span><span class="op">(</span><span class="st">"Two"</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="checkboxInput.html">checkboxInput</a></span><span class="op">(</span><span class="st">"chk2"</span>, <span class="st">"Checkbox 2"</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> <span class="fu">bookmarkButton</span><span class="op">(</span>id <span class="op">=</span> <span class="st">"bookmark2"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">}</span></span></span>
|
||
<span class="r-in"><span><span class="va">server</span> <span class="op"><-</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span>, <span class="va">session</span><span class="op">)</span> <span class="op">{</span></span></span>
|
||
<span class="r-in"><span> <span class="co"># Need to exclude the buttons from themselves being bookmarked</span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="setBookmarkExclude.html">setBookmarkExclude</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"bookmark1"</span>, <span class="st">"bookmark2"</span><span class="op">)</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span> <span class="co"># Trigger bookmarking with either button</span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="observeEvent.html">observeEvent</a></span><span class="op">(</span><span class="va">input</span><span class="op">$</span><span class="va">bookmark1</span>, <span class="op">{</span></span></span>
|
||
<span class="r-in"><span> <span class="va">session</span><span class="op">$</span><span class="fu">doBookmark</span><span class="op">(</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">}</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="observeEvent.html">observeEvent</a></span><span class="op">(</span><span class="va">input</span><span class="op">$</span><span class="va">bookmark2</span>, <span class="op">{</span></span></span>
|
||
<span class="r-in"><span> <span class="va">session</span><span class="op">$</span><span class="fu">doBookmark</span><span class="op">(</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span> <span class="op">}</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">}</span></span></span>
|
||
<span class="r-in"><span><span class="fu"><a href="enableBookmarking.html">enableBookmarking</a></span><span class="op">(</span>store <span class="op">=</span> <span class="st">"url"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="fu"><a href="shinyApp.html">shinyApp</a></span><span class="op">(</span><span class="va">ui</span>, <span class="va">server</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">}</span></span></span>
|
||
</code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
||
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
|
||
</nav></div>
|
||
</div>
|
||
|
||
|
||
<footer><div class="copyright">
|
||
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Garrick Aden-Buie, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges, Posit Software, PBC.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown">
|
||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|