mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
195 lines
13 KiB
HTML
195 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 navigation list panel — navlistPanel • 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 navigation list panel — navlistPanel"><meta property="og:description" content="Create a navigation list panel that provides a list of links on the left
|
|
which navigate to a set of tabPanels displayed to the right."><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.9000</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 navigation list panel</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/main/R/bootstrap.R" class="external-link"><code>R/bootstrap.R</code></a></small>
|
|
<div class="hidden name"><code>navlistPanel.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Create a navigation list panel that provides a list of links on the left
|
|
which navigate to a set of tabPanels displayed to the right.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">navlistPanel</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> header <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> footer <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> well <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> fluid <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> widths <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="fl">4</span>, <span class="fl">8</span><span class="op">)</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 navlist</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 navlist items 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 navigation item that should be selected by default. If <code>NULL</code>,
|
|
the first navigation will be selected.</p></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>
|
|
|
|
|
|
<dt id="arg-well">well<a class="anchor" aria-label="anchor" href="#arg-well"></a></dt>
|
|
<dd><p><code>TRUE</code> to place a well (gray rounded rectangle) around the
|
|
navigation list.</p></dd>
|
|
|
|
|
|
<dt id="arg-fluid">fluid<a class="anchor" aria-label="anchor" href="#arg-fluid"></a></dt>
|
|
<dd><p><code>TRUE</code> to use fluid layout; <code>FALSE</code> to use fixed
|
|
layout.</p></dd>
|
|
|
|
|
|
<dt id="arg-widths">widths<a class="anchor" aria-label="anchor" href="#arg-widths"></a></dt>
|
|
<dd><p>Column widths of the navigation list and tabset content areas
|
|
respectively.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p>You can include headers within the <code>navlistPanel</code> by including
|
|
plain text elements in the list. Versions of Shiny before 0.11 supported
|
|
separators with "——", but as of 0.11, separators were no longer
|
|
supported. This is because version 0.11 switched to Bootstrap 3, which
|
|
doesn't support separators.</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">updateNavlistPanel()</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="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="titlePanel.html">titlePanel</a></span><span class="op">(</span><span class="st">"Application Title"</span><span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span> <span class="fu">navlistPanel</span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="st">"Header"</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">"First"</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">"Second"</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">"Third"</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">#></span> <div class="container-fluid"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <h2>Application Title</h2></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="row"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="col-sm-4 well"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav nav-pills nav-stacked" data-tabsetid="6386"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <li class="navbar-brand">Header</li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <li class="active"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6386-2" data-toggle="tab" data-bs-toggle="tab" data-value="First">First</a></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6386-3" data-toggle="tab" data-bs-toggle="tab" data-value="Second">Second</a></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6386-4" data-toggle="tab" data-bs-toggle="tab" data-value="Third">Third</a></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </ul></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="col-sm-8"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="6386"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="First" id="tab-6386-2"></div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Second" id="tab-6386-3"></div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Third" id="tab-6386-4"></div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></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>
|
|
|