mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 15:38:19 -05:00
156 lines
10 KiB
HTML
156 lines
10 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 HTML output element — htmlOutput • 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 an HTML output element — htmlOutput"><meta property="og:description" content="Render a reactive output variable as HTML within an application page. The
|
|
text will be included within an HTML div tag, and is presumed to contain
|
|
HTML content which should not be escaped."><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.0.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 an HTML output element</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/rc-v1.12.1/R/bootstrap.R" class="external-link"><code>R/bootstrap.R</code></a></small>
|
|
<div class="hidden name"><code>htmlOutput.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Render a reactive output variable as HTML within an application page. The
|
|
text will be included within an HTML <code>div</code> tag, and is presumed to contain
|
|
HTML content which should not be escaped.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">htmlOutput</span><span class="op">(</span></span>
|
|
<span> <span class="va">outputId</span>,</span>
|
|
<span> inline <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> container <span class="op">=</span> <span class="kw">if</span> <span class="op">(</span><span class="va">inline</span><span class="op">)</span> <span class="va">span</span> <span class="kw">else</span> <span class="va">div</span>,</span>
|
|
<span> fill <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> <span class="va">...</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">uiOutput</span><span class="op">(</span></span>
|
|
<span> <span class="va">outputId</span>,</span>
|
|
<span> inline <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> container <span class="op">=</span> <span class="kw">if</span> <span class="op">(</span><span class="va">inline</span><span class="op">)</span> <span class="va">span</span> <span class="kw">else</span> <span class="va">div</span>,</span>
|
|
<span> fill <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> <span class="va">...</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
|
|
|
|
<dl><dt id="arg-outputid">outputId<a class="anchor" aria-label="anchor" href="#arg-outputid"></a></dt>
|
|
<dd><p>output variable to read the value from</p></dd>
|
|
|
|
|
|
<dt id="arg-inline">inline<a class="anchor" aria-label="anchor" href="#arg-inline"></a></dt>
|
|
<dd><p>use an inline (<code><a href="https://rstudio.github.io/htmltools/reference/builder.html" class="external-link">span()</a></code>) or block container (<code><a href="https://rstudio.github.io/htmltools/reference/builder.html" class="external-link">div()</a></code>)
|
|
for the output</p></dd>
|
|
|
|
|
|
<dt id="arg-container">container<a class="anchor" aria-label="anchor" href="#arg-container"></a></dt>
|
|
<dd><p>a function to generate an HTML element to contain the text</p></dd>
|
|
|
|
|
|
<dt id="arg-fill">fill<a class="anchor" aria-label="anchor" href="#arg-fill"></a></dt>
|
|
<dd><p>If <code>TRUE</code>, the result of <code>container</code> is treated as <em>both</em> a fill
|
|
item and container (see <code><a href="https://rstudio.github.io/htmltools/reference/bindFillRole.html" class="external-link">htmltools::bindFillRole()</a></code>), which means both the
|
|
<code>container</code> as well as its immediate children (i.e., the result of
|
|
<code><a href="renderUI.html">renderUI()</a></code>) are allowed to grow/shrink to fit a fill container with an
|
|
opinionated height. Set <code>fill = "item"</code> or <code>fill = "container"</code> to treat
|
|
<code>container</code> as just a fill item or a fill container.</p></dd>
|
|
|
|
|
|
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
|
<dd><p>Other arguments to pass to the container tag function. This is
|
|
useful for providing additional classes for the tag.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
<p>An HTML output element that can be included in a panel</p>
|
|
</div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p><code>uiOutput</code> is intended to be used with <code>renderUI</code> on the server side. It is
|
|
currently just an alias for <code>htmlOutput</code>.</p>
|
|
</div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">htmlOutput</span><span class="op">(</span><span class="st">"summary"</span><span class="op">)</span></span></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <div id="summary" class="shiny-html-output"></div></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="co"># Using a custom container and class</span></span></span>
|
|
<span class="r-in"><span><span class="va">tags</span><span class="op">$</span><span class="fu">ul</span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">htmlOutput</span><span class="op">(</span><span class="st">"summary"</span>, container <span class="op">=</span> <span class="va">tags</span><span class="op">$</span><span class="va">li</span>, class <span class="op">=</span> <span class="st">"custom-li-output"</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> <ul></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> <li class="shiny-html-output custom-li-output" id="summary"></li></span>
|
|
<span class="r-out co"><span class="r-pr">#></span> </ul></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>
|
|
|