-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
tooltips.html
270 lines (257 loc) · 9.92 KB
/
tooltips.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
<!DOCTYPE html>
<html lang="en">
<head>
{{> head }}
</head>
<body>
{{> navbar }}
<main>
{{> intro}}
<div class="container">
<div class="row">
<div class="col s12 m8 offset-m1 xl7 offset-xl1">
<!-- Tooltip Section -->
<div id="introduction" class="scrollspy section">
<p>
Tooltips are small, interactive, textual hints for mainly graphical elements. When using icons for actions you can use a tooltip to give people clarification on its
function.
</p>
<div>
<a href="#" class="btn tooltipped" data-html="true" data-position="bottom" data-tooltip-id="tooltip-content"> Bottom</a>
<div id="tooltip-content" style="display: grid; align-content: center">
This is a tooltip with a
<a href="https://github.com/materializecss">link</a> and a
<i class="material-icons icon-demo">insert_chart</i>
</div>
<a href="#" class="btn tooltipped" data-position="top" data-tooltip="I am a top tooltip"> Top</a>
<a href="#" class="btn tooltipped" data-position="left" data-tooltip="I am a left tooltip"> Left</a>
<a
href="#"
class="btn tooltipped"
data-position="right"
data-tooltip="I am a right tooltip. Lorem, ipsum dolor sit amet consectetur adipisicing elit. Nesciunt ducimus possimus quidem voluptatem soluta ex dignissimos, itaque magnam aspernatur eum deleniti delectus, vitae rerum, distinctio quam? Quas sapiente sunt blanditiis?"
>
Right</a
>
</div>
<p>Add the Tooltipped class to your element and add either top, bottom, left, right on data-tooltip to control the position.</p>
<pre><code class="language-html">
<xmp>
<!-- data-position can be : bottom, top, left, or right -->
<!-- data-tooltip defines the tooltip text -->
<a class="btn tooltipped" data-position="bottom" data-tooltip="I am a tooltip">Hover me!</a>
</xmp>
</code></pre>
<p>
Also HTML-Elements can be added with the attribute
<code>data-tooltip-id="tooltip-content"</code>
</p>
<pre><code class="language-html">
<xmp>
<a href="#" class="btn tooltipped" data-html="true" data-position="bottom" data-tooltip-id="tooltip-content">
Bottom
</a>
<div id="tooltip-content" style="display: none;">
This is a tooltip with a
<a href="https://github.com/materializecss">link</a> and a
<i class="material-icons icon-demo">insert_chart</i>
</div>
</xmp>
</code></pre>
</div>
<div id="initialization" class="scrollspy section">
<h3 class="header">Initialization</h3>
<pre><code class="language-javascript">
document.addEventListener('DOMContentLoaded', function() {
var elems = document.querySelectorAll('.tooltipped');
var instances = M.Tooltip.init(elems, {
// specify options here
});
});
</code>
</pre>
</div>
<div id="options" class="section scrollspy">
<h3 class="header">Options</h3>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>exitDelay</td>
<td>Number</td>
<td>200</td>
<td>Delay time before tooltip disappears.</td>
</tr>
<tr>
<td>enterDelay</td>
<td>Number</td>
<td>0</td>
<td>Delay time before tooltip appears.</td>
</tr>
<tr>
<td>text</td>
<td>String</td>
<td></td>
<td>Text string for the tooltip.</td>
</tr>
<tr>
<td>unsafeHTML</td>
<td>String</td>
<td>null</td>
<td>
HTML content that will be appended to to
<code class="language-javascript">text</code>. Only use properly sanitized or otherwise trusted data for <code class="language-javascript">unsafeHTML</code>.
</td>
</tr>
<tr>
<td>html</td>
<td>String</td>
<td>null</td>
<td>
<p>(DEPRECATED): will be removed in a later release.</p>
<p>
HTML content that will be appended to
<code class="language-javascript">text</code>. Only use properly sanitized or otherwise trusted data for <code class="language-javascript">html</code>.
</p>
<p>
Will be ignored if
<code class="language-javascript">unsafeHTML</code> is set.
</p>
</td>
</tr>
<tr>
<td>margin</td>
<td>Number</td>
<td>5</td>
<td>Set distance tooltip appears away from its activator excluding transitionMovement.</td>
</tr>
<tr>
<td>inDuration</td>
<td>Number</td>
<td>300</td>
<td>Enter transition duration.</td>
</tr>
<tr>
<td>opacity</td>
<td>Number</td>
<td>1</td>
<td>Opacity of the tooltip.</td>
</tr>
<tr>
<td>outDuration</td>
<td>Number</td>
<td>250</td>
<td>Exit transition duration.</td>
</tr>
<tr>
<td>position</td>
<td>String</td>
<td>'bottom'</td>
<td>Set the direction of the tooltip. 'top', 'right', 'bottom', 'left'.</td>
</tr>
<tr>
<td>transitionMovement</td>
<td>Number</td>
<td>10</td>
<td>Amount in px that the tooltip moves during its transition.</td>
</tr>
</tbody>
</table>
</div>
<div id="methods" class="section scrollspy">
<h3 class="header">Methods</h3>
<blockquote>
<p>All the methods are called on the plugin instance. You can get the plugin instance like this:</p>
<pre><code class="language-javascript col s12">
var instance = M.Tooltip.getInstance(elem);
</code></pre>
</blockquote>
<h5 class="method-header">.open();</h5>
<p>Show tooltip.</p>
<pre><code class="language-javascript col s12">
instance.open();
</code></pre>
<h5 class="method-header">.close();</h5>
<p>Hide tooltip.</p>
<pre><code class="language-javascript col s12">
instance.close();
</code></pre>
<h5 class="method-header">.destroy();</h5>
<p>Destroy plugin instance and teardown</p>
<pre><code class="language-javascript col s12">
instance.destroy();
</code></pre>
</div>
<div id="properties" class="scrollspy section">
<h3 class="header">Properties</h3>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>el</td>
<td>Element</td>
<td>The DOM element the plugin was initialized with.</td>
</tr>
<tr>
<td>options</td>
<td>Object</td>
<td>The options the instance was initialized with.</td>
</tr>
<tr>
<td>isOpen</td>
<td>Boolean</td>
<td>If tooltip is open.</td>
</tr>
<tr>
<td>isHovered</td>
<td>Boolean</td>
<td>If tooltip is hovered.</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- Table of Contents -->
<div class="col hide-on-small-only m3 xl3">
<div class="toc-wrapper">
<div style="height: 1px">
<ul class="section table-of-contents">
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#initialization">Initialization</a>
</li>
<li>
<a href="#options">Options</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
<li>
<a href="#properties">Properties</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</main>
{{> footer }}
<script type="module" src="/src/main.ts"></script>
</body>
</html>