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
|
+++
title = "Toggleme"
date = "2017-04-10T16:42:59+01:00"
draft = false
weight = 190
description = "Display or hide elements with simple toggle"
bref= "Toggleme is a great way to add a binary option to either display some content or hide it. It works like a charm for menus, disclaimers and so much more!"
toc = true
+++
<h3 class="section-head" id="h-demo"><a href="#h-demo">Demo</a></h3>
<p>Toggleme works on mobile devices as well as on desktops. To see Toggleme in action, just resize this window or open this page on a mobile device.</p>
<div class="example">
<div class="show-sm">
<a data-component="toggleme" data-target="#navbar" href="#"><b>Toggle</b></a>
</div>
<div class="hide-sm" id="navbar">
<div id="navbar-demo">
<div id="navbar-brand">
<a href=""><img alt="Brand" src="/img/kube/brand.png"></a>
</div>
<nav id="navbar-main">
<ul>
<li>
<a href="#">Shop</a>
</li>
<li>
<a href="#">News</a>
</li>
<li>
<a href="#">Contact</a>
</li>
<li>
<a href="#">Blog</a>
</li>
<li>
<a href="#">Account</a>
</li>
</ul>
</nav>
</div>
</div>
<pre class="code skip"><span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"show-sm"</span>></span>
<span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">data-component</span>=<span class="hljs-string">"toggleme"</span> <span class="hljs-attr">data-target</span>=<span class="hljs-string">"#navbar"</span>></span>Toggle<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
<span class="hljs-tag"></<span class="hljs-name">div</span>></span>
<span class="hljs-tag"><<span class="hljs-name">nav</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"navbar"</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"hide-sm"</span>></span>
<span class="hljs-tag"><<span class="hljs-name">ul</span>></span>
<span class="hljs-tag"><<span class="hljs-name">li</span>></span><span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span>></span>...<span class="hljs-tag"></<span class="hljs-name">a</span>></span><span class="hljs-tag"></<span class="hljs-name">li</span>></span>
<span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
<span class="hljs-tag"></<span class="hljs-name">nav</span>></span>
</pre>
</div>
<h3 class="section-head" id="h-usage"><a href="#h-usage">Usage</a></h3>
<div class="example">
<p><button class="button outline" data-component="toggleme" data-target="#togglebox-target-1" data-text="Hide Me">Show Me</button></p>
<div class="togglebox-box hide" id="togglebox-target-1">
<h3>Ok, I'm opened. Now hide me</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
<pre class="code skip"><button data-component=<span class="hljs-string">"toggleme"</span> data-target=<span class="hljs-string">"#togglebox-target"</span> data-<span class="hljs-built_in">text</span>=<span class="hljs-string">"Hide Me"</span>>Show Me</button>
<<span class="hljs-keyword">div</span> <span class="hljs-built_in">id</span>=<span class="hljs-string">"togglebox-target"</span> <span class="hljs-built_in">class</span>=<span class="hljs-string">"hide"</span>>
...
</<span class="hljs-keyword">div</span>>
</pre>
</div>
<h3 class="section-head" id="h-multiple-targets"><a href="#h-multiple-targets">Multiple targets</a></h3>
<div class="example">
<p><button class="button primary outline" data-component="toggleme" data-target="#togglebox-target-3, #togglebox-target-4" data-text="Hide Me">Show Me</button></p>
<div class="togglebox-box hide" id="togglebox-target-3">
<h3>Ok, I'm opened. Now hide me</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
<div class="togglebox-box hide" id="togglebox-target-4">
<h3>... and, I'm opened too. Now hide me</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
<pre class="code skip"><button data-component=<span class="hljs-string">"toggleme"</span> data-target=<span class="hljs-string">"#togglebox-target-3, #togglebox-target-4"</span> data-<span class="hljs-built_in">text</span>=<span class="hljs-string">"Hide Me"</span>>Show Me</button>
<<span class="hljs-keyword">div</span> <span class="hljs-built_in">id</span>=<span class="hljs-string">"togglebox-target-1"</span> <span class="hljs-built_in">class</span>=<span class="hljs-string">"hide"</span>>
...
</<span class="hljs-keyword">div</span>>
<<span class="hljs-keyword">div</span> <span class="hljs-built_in">id</span>=<span class="hljs-string">"togglebox-target-2"</span> <span class="hljs-built_in">class</span>=<span class="hljs-string">"hide"</span>>
...
</<span class="hljs-keyword">div</span>>
</pre>
</div>
<h3 class="section-head" id="h-settings"><a href="#h-settings">Settings</a></h3>
<h5>target</h5>
<ul>
<li>Type: <var>string</var></li>
<li>Default: <var>null</var></li>
<li>Possible values: <var>selector/selectors</var></li>
</ul>
<p>Defines which layer or layers should be displayed upon clicking the "open" button.</p>
<pre class="code skip"><<span class="hljs-keyword">button </span><span class="hljs-meta">data</span>-component=<span class="hljs-string">"toggleme"</span> <span class="hljs-meta">data</span>-target=<span class="hljs-string">"#togglebox-target"</span>>Show Me</<span class="hljs-keyword">button>
</span>
<<span class="hljs-keyword">button </span><span class="hljs-meta">data</span>-component=<span class="hljs-string">"toggleme"</span> <span class="hljs-meta">data</span>-target=<span class="hljs-string">"#togglebox-target-1, #togglebox-target-2"</span>>Show Me</<span class="hljs-keyword">button>
</span>
<<span class="hljs-keyword">button </span><span class="hljs-meta">data</span>-component=<span class="hljs-string">"toggleme"</span> <span class="hljs-meta">data</span>-target=<span class="hljs-string">".togglebox-target"</span>>Show Me</<span class="hljs-keyword">button>
</span>
</pre>
<h5>text</h5>
<ul>
<li>Type: <var>string</var></li>
<li>Default: <var>''</var></li>
</ul>
<p>Defines what text should a button have after the layer has been opened. If not set, button text will not change.</p>
<pre class="code skip"><<span class="hljs-keyword">button </span><span class="hljs-meta">data</span>-component=<span class="hljs-string">"toggleme"</span> <span class="hljs-meta">data</span>-target=<span class="hljs-string">"#togglebox-target"</span> <span class="hljs-meta">data</span>-text=<span class="hljs-string">"Hide Me"</span>>Show Me</<span class="hljs-keyword">button>
</span>
</pre>
<h3 class="section-head" id="h-callbacks"><a href="#h-callbacks">Callbacks</a></h3>
<h5>open</h5>
<pre class="code skip">$(<span class="hljs-string">'#togglebox-target'</span>).on(<span class="hljs-string">'open.toggleme'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)
</span>{
<span class="hljs-comment">// do something...</span>
});
</pre>
<h5>opened</h5>
<pre class="code skip">$(<span class="hljs-string">'#togglebox-target'</span>).on(<span class="hljs-string">'opened.toggleme'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)
</span>{
<span class="hljs-comment">// do something...</span>
});
</pre>
<h5>close</h5>
<pre class="code skip">$(<span class="hljs-string">'#togglebox-target'</span>).on(<span class="hljs-string">'close.toggleme'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)
</span>{
<span class="hljs-comment">// do something...</span>
});
</pre>
<h5>closed</h5>
<pre class="code skip">$(<span class="hljs-string">'#togglebox-target'</span>).on(<span class="hljs-string">'closed.toggleme'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)
</span>{
<span class="hljs-comment">// do something...</span>
});
</pre>
<h3 class="section-head" id="h-api"><a href="#h-api">API</a></h3>
<h5>toggle</h5>
<pre class="code skip"><span class="hljs-variable">$(</span><span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'toggle'</span>);
</pre>
<h5>open</h5>
<pre class="code skip"><span class="hljs-variable">$(</span><span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'open'</span>);
</pre>
<h5>close</h5>
<pre class="code skip"><span class="hljs-variable">$(</span><span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'close'</span>);
</pre>
<h5>isOpened</h5>
<pre class="code skip"><span class="hljs-keyword">var</span> isOpened = $(<span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'isOpened'</span>);
</pre>
<h5>isClosed</h5>
<pre class="code skip"><span class="hljs-keyword">var</span> isClosed = $(<span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'isClosed'</span>);
</pre>
<h5>destroy</h5>
<pre class="code skip"><span class="hljs-variable">$(</span><span class="hljs-string">'#togglebox-target'</span>).toggleme(<span class="hljs-string">'destroy'</span>);
</pre>
|
