/
bs_accordion.html
273 lines (222 loc) · 12 KB
/
bs_accordion.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
<head>
<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>Accordion panel-group — bs_accordion • bsplus</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/sandstone/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Accordion panel-group — bs_accordion" />
<meta property="og:description" content="An accordion is a set of collapsible panels where, at most, one panel-body is visible." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
<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">
<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">bsplus</a>
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.1.0.9</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/accordion.html">Accordion</a>
</li>
<li>
<a href="../articles/accordion_sidebar.html">Accordion Sidebar</a>
</li>
<li>
<a href="../articles/carousel.html">Carousel</a>
</li>
<li>
<a href="../articles/collapse.html">Collapse</a>
</li>
<li>
<a href="../articles/modal.html">Modals</a>
</li>
<li>
<a href="../articles/overview.html">Overview</a>
</li>
<li>
<a href="../articles/shiny_help_links.html">Shiny-input help links</a>
</li>
<li>
<a href="../articles/tooltip_popover.html">Tooltips and popovers</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/ijlyttle/bsplus">
<span class="fa 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>Accordion panel-group</h1>
<small>Source: <a href='https://github.com/ijlyttle/bsplus/blob/master/R/accordion.R'><code>R/accordion.R</code></a>, <a href='https://github.com/ijlyttle/bsplus/blob/master/R/append.R'><code>R/append.R</code></a>, <a href='https://github.com/ijlyttle/bsplus/blob/master/R/set_opts.R'><code>R/set_opts.R</code></a></small>
</div>
<p>An accordion is a set of collapsible panels where, at most, one panel-body is visible.</p>
<pre class="usage"><span class='fu'>bs_accordion</span>(<span class='no'>id</span>)
<span class='co'># S3 method for bsplus_accordion</span>
<span class='fu'><a href='bs_append.html'>bs_append</a></span>(<span class='no'>tag</span>, <span class='no'>title</span>, <span class='no'>content</span>, <span class='no'>...</span>)
<span class='co'># S3 method for bsplus_accordion</span>
<span class='fu'><a href='bs_set_opts.html'>bs_set_opts</a></span>(<span class='no'>tag</span>, <span class='kw'>panel_type</span> <span class='kw'>=</span> <span class='st'>"primary"</span>,
<span class='kw'>use_heading_link</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='no'>...</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>id</th>
<td><p>character, unique id for accordion <code><div/></code>,
also serves as root id for panels appended using <code><a href='bs_append.html'>bs_append()</a></code></p></td>
</tr>
<tr>
<th>tag</th>
<td><p><code>htmltools::<a href='http://www.rdocumentation.org/packages/htmltools/topics/tag'>tag</a></code>,
accordion <code><div/></code> to which to append a panel</p></td>
</tr>
<tr>
<th>title</th>
<td><p>character (HTML) or <code>htmltools::<a href='http://www.rdocumentation.org/packages/htmltools/topics/tag'>tagList</a></code>,
title for the panel heading</p></td>
</tr>
<tr>
<th>content</th>
<td><p>character (HTML) or <code>htmltools::<a href='http://www.rdocumentation.org/packages/htmltools/topics/tag'>tagList</a></code>,
content for the panel body</p></td>
</tr>
<tr>
<th>...</th>
<td><p>other args (not used)</p></td>
</tr>
<tr>
<th>panel_type</th>
<td><p>character, one of the standard Bootstrap types
<code>c("default", "primary", "success", "info", "warning", "danger")</code></p></td>
</tr>
<tr>
<th>use_heading_link</th>
<td><p>logical, indicates whether to make the entire panel heading
clickable.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p><code>bsplus_accordion</code> object (<code>htmltools::<a href='http://www.rdocumentation.org/packages/htmltools/topics/tag'>tag</a></code>,
<code><div/></code>)</p>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>All of these functions return a <code>bsplus_accordion</code> object
(which is also an <code>htmltools::<a href='http://www.rdocumentation.org/packages/htmltools/topics/tag'>tag</a></code>, <code><div/></code>), so you can
compose an accordion by piping. There are three parts to this system:</p>
<ol>
<li><p>A constructor function for the accordion, <code>bs_accordion()</code></p></li>
<li><p>A function to set options for subsequent panels, <code><a href='bs_set_opts.html'>bs_set_opts()</a></code></p></li>
<li><p>A function to append a panel to the group, <code><a href='bs_append.html'>bs_append()</a></code></p></li>
</ol>
<p>The verb <em>append</em> is used to signify that you can append an arbitrary
number of panels to an accordion.</p>
<p>For the constructor, <code>bs_accordion()</code>,
it is your responsibility to ensure that <code>id</code> is unique
among HTML elements in your page. If you have non-unique <code>id</code>'s, strange things may
happen to your page.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p><a href='http://getbootstrap.com/javascript/#collapse-example-accordion'>http://getbootstrap.com/javascript/#collapse-example-accordion</a></p></div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='fu'>bs_accordion</span>(<span class='kw'>id</span> <span class='kw'>=</span> <span class='st'>"meet_the_beatles"</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='bs_set_opts.html'>bs_set_opts</a></span>(<span class='kw'>panel_type</span> <span class='kw'>=</span> <span class='st'>"success"</span>, <span class='kw'>use_heading_link</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='bs_append.html'>bs_append</a></span>(<span class='kw'>title</span> <span class='kw'>=</span> <span class='st'>"John Lennon"</span>, <span class='kw'>content</span> <span class='kw'>=</span> <span class='st'>"Rhythm guitar, vocals"</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='bs_set_opts.html'>bs_set_opts</a></span>(<span class='kw'>panel_type</span> <span class='kw'>=</span> <span class='st'>"info"</span>) <span class='kw'>%>%</span>
<span class='fu'><a href='bs_append.html'>bs_append</a></span>(<span class='kw'>title</span> <span class='kw'>=</span> <span class='st'>"Paul McCartney"</span>, <span class='kw'>content</span> <span class='kw'>=</span> <span class='st'>"Bass guitar, vocals"</span>)</div><div class='output co'>#> <div id="meet_the_beatles" class="panel-group" role="tablist" aria-multiselectable="true">
#> <div class="panel panel-success" id="meet_the_beatles-0">
#> <div id="meet_the_beatles-0-heading" class="panel-heading" role="tab" data-toggle="collapse" data-target="#meet_the_beatles-0-collapse" data-parent="#meet_the_beatles" aria-expanded="true" aria-controls="meet_the_beatles-0-collapse" style="cursor: pointer;">
#> <h4 class="panel-title">John Lennon</h4>
#> </div>
#> <div aria-labelledby="meet_the_beatles-0-heading" class="panel-collapse collapse in" id="meet_the_beatles-0-collapse" role="tabpanel">
#> <div class="panel-body" style="">Rhythm guitar, vocals</div>
#> </div>
#> </div>
#> <div class="panel panel-info" id="meet_the_beatles-1">
#> <div id="meet_the_beatles-1-heading" class="panel-heading" role="tab" data-toggle="collapse" data-target="#meet_the_beatles-1-collapse" data-parent="#meet_the_beatles" aria-expanded="true" aria-controls="meet_the_beatles-1-collapse" style="cursor: pointer;">
#> <h4 class="panel-title">Paul McCartney</h4>
#> </div>
#> <div id="meet_the_beatles-1-collapse" class="panel-collapse collapse" role="tabpanel" aria-labelledby="meet_the_beatles-1-heading">
#> <div class="panel-body" style="">Bass guitar, vocals</div>
#> </div>
#> </div>
#> </div></div><div class='input'>
</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#details">Details</a></li>
<li><a href="#see-also">See also</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Ian Lyttle.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
</div>
</body>
</html>