Files
shiny/reference/tabsetPanel.html
2024-12-10 14:33:17 +00:00

217 lines
18 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 tabset panel — tabsetPanel • 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 tabset panel — tabsetPanel"><meta property="og:description" content="Create a tabset that contains tabPanel() elements. Tabsets are
useful for dividing output into multiple independently viewable sections."><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.10.0</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 tabset panel</h1>
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/rc-v1.10.0/R/bootstrap.R" class="external-link"><code>R/bootstrap.R</code></a></small>
<div class="hidden name"><code>tabsetPanel.Rd</code></div>
</div>
<div class="ref-description">
<p>Create a tabset that contains <code><a href="tabPanel.html">tabPanel()</a></code> elements. Tabsets are
useful for dividing output into multiple independently viewable sections.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">tabsetPanel</span><span class="op">(</span></span>
<span> <span class="va">...</span>,</span>
<span> id <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> selected <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> type <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">"tabs"</span>, <span class="st">"pills"</span>, <span class="st">"hidden"</span><span class="op">)</span>,</span>
<span> header <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> footer <span class="op">=</span> <span class="cn">NULL</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p><code><a href="tabPanel.html">tabPanel()</a></code> elements to include in the tabset</p></dd>
<dt id="arg-id">id<a class="anchor" aria-label="anchor" href="#arg-id"></a></dt>
<dd><p>If provided, you can use <code>input$</code><em><code>id</code></em> in your
server logic to determine which of the current tabs is active. The value
will correspond to the <code>value</code> argument that is passed to
<code><a href="tabPanel.html">tabPanel()</a></code>.</p></dd>
<dt id="arg-selected">selected<a class="anchor" aria-label="anchor" href="#arg-selected"></a></dt>
<dd><p>The <code>value</code> (or, if none was supplied, the <code>title</code>)
of the tab that should be selected by default. If <code>NULL</code>, the first
tab will be selected.</p></dd>
<dt id="arg-type">type<a class="anchor" aria-label="anchor" href="#arg-type"></a></dt>
<dd><dl><dt><code>"tabs"</code></dt>
<dd><p>Standard tab look</p></dd>
<dt><code>"pills"</code></dt>
<dd><p>Selected tabs use the background fill color</p></dd>
<dt><code>"hidden"</code></dt>
<dd><p>Hides the selectable tabs. Use <code>type = "hidden"</code> in
conjunction with <code><a href="tabPanel.html">tabPanelBody()</a></code> and <code><a href="updateTabsetPanel.html">updateTabsetPanel()</a></code> to control the
active tab via other input controls. (See example below)</p></dd>
</dl></dd>
<dt id="arg-header">header<a class="anchor" aria-label="anchor" href="#arg-header"></a></dt>
<dd><p>Tag or list of tags to display as a common header above all
tabPanels.</p></dd>
<dt id="arg-footer">footer<a class="anchor" aria-label="anchor" href="#arg-footer"></a></dt>
<dd><p>Tag or list of tags to display as a common footer below all
tabPanels</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>A tabset that can be passed to <code><a href="sidebarLayout.html">mainPanel()</a></code></p>
</div>
<div id="see-also">
<h2>See also</h2>
<div class="dont-index"><p><code><a href="tabPanel.html">tabPanel()</a></code>, <code><a href="updateTabsetPanel.html">updateTabsetPanel()</a></code>,
<code><a href="insertTab.html">insertTab()</a></code>, <code><a href="showTab.html">showTab()</a></code></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"># Show a tabset that includes a plot, summary, and</span></span></span>
<span class="r-in"><span><span class="co"># table view of the generated distribution</span></span></span>
<span class="r-in"><span><span class="fu"><a href="sidebarLayout.html">mainPanel</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="fu">tabsetPanel</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">"Plot"</span>, <span class="fu"><a href="plotOutput.html">plotOutput</a></span><span class="op">(</span><span class="st">"plot"</span><span class="op">)</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">"Summary"</span>, <span class="fu"><a href="textOutput.html">verbatimTextOutput</a></span><span class="op">(</span><span class="st">"summary"</span><span class="op">)</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">"Table"</span>, <span class="fu"><a href="renderTable.html">tableOutput</a></span><span class="op">(</span><span class="st">"table"</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="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="col-sm-8" role="main"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="tabbable"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;ul class="nav nav-tabs" data-tabsetid="6883"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;li class="active"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;a href="#tab-6883-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"&gt;Plot&lt;/a&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/li&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;li&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;a href="#tab-6883-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"&gt;Summary&lt;/a&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/li&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;li&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;a href="#tab-6883-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"&gt;Table&lt;/a&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/li&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/ul&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="tab-content" data-tabsetid="6883"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="tab-pane active" data-value="Plot" id="tab-6883-1"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="shiny-plot-output html-fill-item" id="plot" style="width:100%;height:400px;"&gt;&lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="tab-pane" data-value="Summary" id="tab-6883-2"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;pre class="shiny-text-output noplaceholder" id="summary"&gt;&lt;/pre&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div class="tab-pane" data-value="Table" id="tab-6883-3"&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;div id="table" class="shiny-html-output"&gt;&lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;/div&gt;</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">ui</span> <span class="op">&lt;-</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="sidebarLayout.html">sidebarLayout</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="sidebarLayout.html">sidebarPanel</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="radioButtons.html">radioButtons</a></span><span class="op">(</span><span class="st">"controller"</span>, <span class="st">"Controller"</span>, <span class="fl">1</span><span class="op">:</span><span class="fl">3</span>, <span class="fl">1</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="sidebarLayout.html">mainPanel</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="fu">tabsetPanel</span><span class="op">(</span></span></span>
<span class="r-in"><span> id <span class="op">=</span> <span class="st">"hidden_tabs"</span>,</span></span>
<span class="r-in"><span> <span class="co"># Hide the tab values.</span></span></span>
<span class="r-in"><span> <span class="co"># Can only switch tabs by using `updateTabsetPanel()`</span></span></span>
<span class="r-in"><span> type <span class="op">=</span> <span class="st">"hidden"</span>,</span></span>
<span class="r-in"><span> <span class="fu"><a href="tabPanel.html">tabPanelBody</a></span><span class="op">(</span><span class="st">"panel1"</span>, <span class="st">"Panel 1 content"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> <span class="fu"><a href="tabPanel.html">tabPanelBody</a></span><span class="op">(</span><span class="st">"panel2"</span>, <span class="st">"Panel 2 content"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> <span class="fu"><a href="tabPanel.html">tabPanelBody</a></span><span class="op">(</span><span class="st">"panel3"</span>, <span class="st">"Panel 3 content"</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></span>
<span class="r-in"><span><span class="va">server</span> <span class="op">&lt;-</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="fu"><a href="observeEvent.html">observeEvent</a></span><span class="op">(</span><span class="va">input</span><span class="op">$</span><span class="va">controller</span>, <span class="op">{</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="updateTabsetPanel.html">updateTabsetPanel</a></span><span class="op">(</span><span class="va">session</span>, <span class="st">"hidden_tabs"</span>, selected <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste0</a></span><span class="op">(</span><span class="st">"panel"</span>, <span class="va">input</span><span class="op">$</span><span class="va">controller</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></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 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, 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.1.1.</p>
</div>
</footer></div>
</body></html>