mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
169 lines
14 KiB
HTML
169 lines
14 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 an icon — icon • shiny</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></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 an icon — icon"><meta property="og:description" content="Create an icon for use within a page. Icons can appear on their own, inside
|
|
of a button, and/or used with tabPanel() and navbarMenu()."><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.7.1.9002</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 an icon</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/bootstrap.R" class="external-link"><code>R/bootstrap.R</code></a></small>
|
|
<div class="hidden name"><code>icon.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Create an icon for use within a page. Icons can appear on their own, inside
|
|
of a button, and/or used with <code><a href="tabPanel.html">tabPanel()</a></code> and <code><a href="navbarPage.html">navbarMenu()</a></code>.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">icon</span><span class="op">(</span><span class="va">name</span>, class <span class="op">=</span> <span class="cn">NULL</span>, lib <span class="op">=</span> <span class="st">"font-awesome"</span>, <span class="va">...</span><span class="op">)</span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
<dl><dt>name</dt>
|
|
<dd><p>The name of the icon. A name from either <a href="https://fontawesome.com/" class="external-link">Font Awesome</a> (when <code>lib="font-awesome"</code>) or
|
|
<a href="https://getbootstrap.com/docs/3.3/components/#glyphicons" class="external-link">Bootstrap Glyphicons</a> (when
|
|
<code>lib="glyphicon"</code>) may be provided. Note that the <code>"fa-"</code> and
|
|
<code>"glyphicon-"</code> prefixes should not appear in name (i.e., the
|
|
<code>"fa-calendar"</code> icon should be referred to as <code>"calendar"</code>). A <code>name</code> of
|
|
<code>NULL</code> may also be provided to get a raw <code><i></code> tag with no library attached
|
|
to it.</p></dd>
|
|
<dt>class</dt>
|
|
<dd><p>Additional classes to customize the style of an icon (see the
|
|
<a href="https://fontawesome.com/how-to-use" class="external-link">usage examples</a> for details on
|
|
supported styles).</p></dd>
|
|
<dt>lib</dt>
|
|
<dd><p>The icon library to use. Either <code>"font-awesome"</code> or <code>"glyphicon"</code>.</p></dd>
|
|
<dt>...</dt>
|
|
<dd><p>Arguments passed to the <code><i></code> tag of <a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">htmltools::tags</a>.</p></dd>
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
<p>An <code><i></code> (icon) HTML tag.</p>
|
|
</div>
|
|
<div id="see-also">
|
|
<h2>See also</h2>
|
|
<div class="dont-index"><p>For lists of available icons, see <a href="https://fontawesome.com/icons" class="external-link">https://fontawesome.com/icons</a>
|
|
and <a href="https://getbootstrap.com/docs/3.3/components/#glyphicons" class="external-link">https://getbootstrap.com/docs/3.3/components/#glyphicons</a></p></div>
|
|
</div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="co"># add an icon to a submit button</span></span>
|
|
<span class="r-in"><span class="fu"><a href="submitButton.html">submitButton</a></span><span class="op">(</span><span class="st">"Update View"</span>, icon <span class="op">=</span> <span class="fu">icon</span><span class="op">(</span><span class="st">"redo"</span><span class="op">)</span><span class="op">)</span></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <button type="submit" class="btn btn-primary"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <i class="fa fa-redo" role="presentation" aria-label="redo icon"></i></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> Update View</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </button></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-in"></span>
|
|
<span class="r-in"><span class="fu"><a href="navbarPage.html">navbarPage</a></span><span class="op">(</span><span class="st">"App Title"</span>,</span>
|
|
<span class="r-in"> <span class="fu"><a href="tabPanel.html">tabPanel</a></span><span class="op">(</span><span class="st">"Plot"</span>, icon <span class="op">=</span> <span class="fu">icon</span><span class="op">(</span><span class="st">"bar-chart-o"</span><span class="op">)</span><span class="op">)</span>,</span>
|
|
<span class="r-in"> <span class="fu"><a href="tabPanel.html">tabPanel</a></span><span class="op">(</span><span class="st">"Summary"</span>, icon <span class="op">=</span> <span class="fu">icon</span><span class="op">(</span><span class="st">"list-alt"</span><span class="op">)</span><span class="op">)</span>,</span>
|
|
<span class="r-in"> <span class="fu"><a href="tabPanel.html">tabPanel</a></span><span class="op">(</span><span class="st">"Table"</span>, icon <span class="op">=</span> <span class="fu">icon</span><span class="op">(</span><span class="st">"table"</span><span class="op">)</span><span class="op">)</span></span>
|
|
<span class="r-in"><span class="op">)</span></span>
|
|
<span class="r-msg co"><span class="r-pr">#></span> This Font Awesome icon ('bar-chart-o') does not exist:</span>
|
|
<span class="r-msg co"><span class="r-pr">#></span> * if providing a custom `html_dependency` these `name` checks can </span>
|
|
<span class="r-msg co"><span class="r-pr">#></span> be deactivated with `verify_fa = FALSE`</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <nav class="navbar navbar-default navbar-static-top" role="navigation"></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> <div class="navbar-header"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <span class="navbar-brand">App Title</span></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="3376"></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-3376-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="bar-chart-o icon" class="fa fa-bar-chart-o fa-fw" role="presentation"></i></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> Plot</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </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-3376-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="list-alt icon" class="fa fa-list-alt fa-fw" role="presentation"></i></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> Summary</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </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-3376-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="table icon" class="fa fa-table fa-fw" role="presentation"></i></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> Table</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </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> </nav></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> <div class="tab-content" data-tabsetid="3376"></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-icon-class="fa fa-bar-chart-o fa-fw" data-value="Plot" id="tab-3376-1"></div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" data-icon-class="fa fa-list-alt fa-fw" id="tab-3376-2"></div></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" data-icon-class="fa fa-table fa-fw" id="tab-3376-3"></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, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.1.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|