mirror of
https://github.com/agdamsbo/FreesearchR.git
synced 2025-09-12 18:09:39 +02:00
138 lines
9.4 KiB
HTML
138 lines
9.4 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, shrink-to-fit=no"><title>Create a select input control with icon(s) — selectInputIcon • FreesearchR</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Montserrat-0.4.10/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.10/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Create a select input control with icon(s) — selectInputIcon"><meta name="description" content="Extend form controls by adding text or icons before,
|
|
after, or on both sides of a classic selectInput."><meta property="og:description" content="Extend form controls by adding text or icons before,
|
|
after, or on both sides of a classic selectInput."><meta property="og:image" content="https://agdamsbo.github.io/FreesearchR/logo.png"><script defer src="https://stats.freesearchr.org/script.js" data-website-id="85bfd1e8-2cbe-4a4a-aa34-1dfb2960905b"></script></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
|
|
|
|
<a class="navbar-brand me-2" href="../index.html">FreesearchR</a>
|
|
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.7.2</small>
|
|
|
|
|
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
<ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/FreesearchR.html">Get started</a></li>
|
|
<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
|
<li class="nav-item dropdown">
|
|
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
|
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/data-types.html">Data types</a></li>
|
|
<li><a class="dropdown-item" href="../articles/missingness.html">Missingness in data</a></li>
|
|
<li><a class="dropdown-item" href="../articles/session.html">Session info</a></li>
|
|
<li><a class="dropdown-item" href="../articles/visuals.html">On visuals</a></li>
|
|
</ul></li>
|
|
<li class="nav-item"><a class="nav-link" href="../ROADMAP.html">Roadmap</a></li>
|
|
<li class="nav-item"><a class="nav-link" href="../QA.html">Q&A</a></li>
|
|
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
|
|
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
|
|
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
|
|
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/agdamsbo/FreesearchR/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
|
|
</ul></div>
|
|
|
|
|
|
</div>
|
|
</nav><div class="container template-reference-topic">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.png" class="logo" alt=""><h1>Create a select input control with icon(s)</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/FreesearchR/blob/main/R/import-file-ext.R" class="external-link"><code>R/import-file-ext.R</code></a></small>
|
|
<div class="d-none name"><code>selectInputIcon.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Extend form controls by adding text or icons before,
|
|
after, or on both sides of a classic <code>selectInput</code>.</p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">selectInputIcon</span><span class="op">(</span></span>
|
|
<span> <span class="va">inputId</span>,</span>
|
|
<span> <span class="va">label</span>,</span>
|
|
<span> <span class="va">choices</span>,</span>
|
|
<span> selected <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> multiple <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> selectize <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> size <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> width <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> icon <span class="op">=</span> <span class="cn">NULL</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
|
|
|
|
<dl><dt id="arg-inputid">inputId<a class="anchor" aria-label="anchor" href="#arg-inputid"></a></dt>
|
|
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
|
|
|
|
|
<dt id="arg-label">label<a class="anchor" aria-label="anchor" href="#arg-label"></a></dt>
|
|
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
|
|
|
|
|
<dt id="arg-choices">choices<a class="anchor" aria-label="anchor" href="#arg-choices"></a></dt>
|
|
<dd><p>List of values to select from. If elements of the list are
|
|
named, then that name — rather than the value — is displayed to the
|
|
user. It's also possible to group related inputs by providing a named list
|
|
whose elements are (either named or unnamed) lists, vectors, or factors. In
|
|
this case, the outermost names will be used as the group labels (leveraging
|
|
the <code><optgroup></code> HTML tag) for the elements in the respective sublist. See
|
|
the example section for a small demo of this feature.</p></dd>
|
|
|
|
|
|
<dt id="arg-selected">selected<a class="anchor" aria-label="anchor" href="#arg-selected"></a></dt>
|
|
<dd><p>The initially selected value (or multiple values if <code>multiple = TRUE</code>). If not specified then defaults to the first value for
|
|
single-select lists and no values for multiple select lists.</p></dd>
|
|
|
|
|
|
<dt id="arg-multiple">multiple<a class="anchor" aria-label="anchor" href="#arg-multiple"></a></dt>
|
|
<dd><p>Is selection of multiple items allowed?</p></dd>
|
|
|
|
|
|
<dt id="arg-selectize">selectize<a class="anchor" aria-label="anchor" href="#arg-selectize"></a></dt>
|
|
<dd><p>Whether to use <span class="pkg">selectize.js</span> or not.</p></dd>
|
|
|
|
|
|
<dt id="arg-size">size<a class="anchor" aria-label="anchor" href="#arg-size"></a></dt>
|
|
<dd><p>Number of items to show in the selection box; a larger number
|
|
will result in a taller box. Not compatible with <code>selectize=TRUE</code>.
|
|
Normally, when <code>multiple=FALSE</code>, a select input will be a drop-down list,
|
|
but when <code>size</code> is set, it will be a box instead.</p></dd>
|
|
|
|
|
|
<dt id="arg-width">width<a class="anchor" aria-label="anchor" href="#arg-width"></a></dt>
|
|
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
|
see <code><a href="https://rstudio.github.io/htmltools/reference/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
<p>A numeric input control that can be added to a UI definition.</p>
|
|
</div>
|
|
|
|
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p>Developed by Andreas Gammelgaard Damsbo. Provided without <strong>any warranty</strong>.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|