forked from boiyelove/materializecss-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
toasts.html
519 lines (485 loc) · 24.7 KB
/
toasts.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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="msapplication-tap-highlight" content="no">
<meta name="description" content="Materialize is a modern responsive CSS framework based on Material Design by Google. ">
<title>Toasts - Materialize</title>
<!-- Favicons-->
<link rel="apple-touch-icon-precomposed" href="images/favicon/apple-touch-icon-152x152.png">
<meta name="msapplication-TileColor" content="#FFFFFF">
<meta name="msapplication-TileImage" content="images/favicon/mstile-144x144.png">
<link rel="icon" href="images/favicon/favicon-32x32.png" sizes="32x32">
<!-- Android 5 Chrome Color-->
<meta name="theme-color" content="#EE6E73">
<!-- CSS-->
<link href="css/prism.css" rel="stylesheet">
<link href="css/ghpages-materialize.css" type="text/css" rel="stylesheet" media="screen,projection">
<link href="https://fonts.googleapis.com/css?family=Inconsolata" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<!-- if !isDemo-->
<!-- script.-->
<!-- window.liveSettings = {-->
<!-- api_key: "a0b49b34b93844c38eaee15690d86413",-->
<!-- picker: "bottom-right",-->
<!-- detectlang: true,-->
<!-- dynamic: true,-->
<!-- autocollect: true-->
<!-- };-->
<!-- script(src='//cdn.transifex.com/live.js')-->
</head>
<body>
<header>
<nav class="top-nav">
<div class="container">
<div class="nav-wrapper">
<div class="row">
<div class="col s12 m10 offset-m1">
<h1 class="header">Toasts</h1>
</div>
</div>
</div>
</div>
</nav>
<div class="container"><a href="toasts.html#" data-target="nav-mobile" class="top-nav sidenav-trigger full hide-on-large-only"><i class="material-icons">menu</i></a></div>
<ul id="nav-mobile" class="sidenav sidenav-fixed">
<li class="logo"><a id="logo-container" href="materializecss_default_2.html" class="brand-logo">
<object id="front-page-logo" type="image/svg+xml" data="res/materialize.svg">Your browser does not support SVG</object></a></li>
<li class="version"><a href="toasts.html#" data-target="version-dropdown" class="dropdown-trigger">
1.0.0-rc.2
<svg class="caret" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M7 10l5 5 5-5z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></a>
<ul id="version-dropdown" class="dropdown-content">
<li><a>1.0.0-rc.2</a></li>
<li><a href="0.100.2/0.100.2.html">0.100.2</a></li>
</ul>
</li>
<li class="search">
<div class="search-wrapper">
<input id="search" placeholder="Search"><i class="material-icons">search</i>
<div class="search-results"></div>
</div>
</li>
<li class="bold"><a href="about.html" class="waves-effect waves-teal">About</a></li>
<li class="bold"><a href="getting-started_2.html" class="waves-effect waves-teal">Getting Started</a></li>
<li class="no-padding">
<ul class="collapsible collapsible-accordion">
<li class="bold"><a class="collapsible-header waves-effect waves-teal">CSS</a>
<div class="collapsible-body">
<ul>
<li><a href="color.html">Color</a></li>
<li><a href="grid.html">Grid</a></li>
<li><a href="helpers.html">Helpers</a></li>
<li><a href="media-css.html">Media</a></li>
<li><a href="pulse.html">Pulse</a></li>
<li><a href="sass.html">Sass</a></li>
<li><a href="shadow.html">Shadow</a></li>
<li><a href="table.html">Table</a></li>
<li><a href="css-transitions.html">Transitions</a></li>
<li><a href="typography.html">Typography</a></li>
</ul>
</div>
</li>
<li class="bold"><a class="collapsible-header waves-effect waves-teal">Components</a>
<div class="collapsible-body">
<ul>
<li><a href="badges.html">Badges</a></li>
<li><a href="buttons.html">Buttons</a></li>
<li><a href="breadcrumbs.html">Breadcrumbs</a></li>
<li><a href="cards.html">Cards</a></li>
<li><a href="collections.html">Collections</a></li>
<li><a href="floating-action-button.html">Floating Action Button</a></li>
<li><a href="footer.html">Footer</a></li>
<li><a href="icons.html">Icons</a></li>
<li><a href="navbar.html">Navbar</a></li>
<li><a href="pagination.html">Pagination</a></li>
<li><a href="preloader.html">Preloader</a></li>
</ul>
</div>
</li>
<li class="bold active"><a class="collapsible-header waves-effect waves-teal">JavaScript</a>
<div class="collapsible-body">
<ul>
<li><a href="auto-init.html">Auto Init</a></li>
<li><a href="carousel.html">Carousel</a></li>
<li><a href="collapsible.html">Collapsible</a></li>
<li><a href="dropdown.html">Dropdown</a></li>
<li><a href="feature-discovery.html">FeatureDiscovery</a></li>
<li><a href="media.html">Media</a></li>
<li><a href="modals.html">Modals</a></li>
<li><a href="parallax.html">Parallax</a></li>
<li><a href="pushpin.html">Pushpin</a></li>
<li><a href="scrollspy.html">Scrollspy</a></li>
<li><a href="sidenav.html">Sidenav</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li class="active"><a href="toasts.html">Toasts</a></li>
<li><a href="tooltips.html">Tooltips</a></li>
<li><a href="waves.html">Waves</a></li>
</ul>
</div>
</li>
<li class="bold"><a class="collapsible-header waves-effect waves-teal">Forms</a>
<div class="collapsible-body">
<ul>
<li><a href="autocomplete.html">Autocomplete</a></li>
<li><a href="checkboxes.html">Checkboxes</a></li>
<li><a href="chips.html">Chips</a></li>
<li><a href="pickers.html">Pickers</a></li>
<li><a href="radio-buttons.html">Radio Buttons</a></li>
<li><a href="range.html">Range</a></li>
<li><a href="select.html">Select</a></li>
<li><a href="switches.html">Switches</a></li>
<li><a href="text-inputs.html">Text Inputs</a></li>
</ul>
</div>
</li>
</ul>
</li>
<li class="bold"><a href="mobile.html" class="waves-effect waves-teal">Mobile</a></li>
<li class="bold"><a href="showcase_2.html" class="waves-effect waves-teal">Showcase</a></li>
<li class="bold"><a href="themes_2.html" class="waves-effect waves-teal">Themes<span class="new badge"></span></a></li>
</ul>
<!-- Sidebar BSA-->
<script src="https://m.servedby-buysellads.com/monetization.js" type="text/javascript"></script>
<div class="bsa-cpc"></div>
<script>
(function(){
if(typeof _bsa !== 'undefined' && _bsa) {
_bsa.init('default', 'CKYD55QM', 'placement:materializecsscom', {
target: '.bsa-cpc',
align: 'horizontal',
disable_css: 'true'
});
}
})();
</script>
<div class="patreon-ad"><a href="https://www.patreon.com/materialize" target="_blank" class="waves-effect">Become a Patron</a></div>
</header>
<main><div class="container">
<div class="row">
<div class="col s12 m8 offset-m1 xl7 offset-xl1">
<div id="introduction" class="section scrollspy">
<p>Materialize provides an easy way for you to send unobtrusive alerts to your users through toasts. These toasts are also placed and sized responsively, try it out by clicking the button below on different device sizes.</p>
<a class="waves-effect waves-light btn" onclick="M.toast({html: 'I am a toast'})">Toast!</a>
<p>To do this, call the M.toast() function programatically in JavaScript.</p>
<pre><code class="language-javascript">
M.toast({html: 'I am a toast!'})
</code></pre>
<p>One way to add this into your application is to add this as an onclick event to a button.</p>
<pre><code class="language-markup">
<a onclick="M.toast({html: 'I am a toast'})" class="btn">Toast!</a>
</code></pre>
</div>
<div id="options" class="scrollspy section">
<h3 class="header">Options</h3>
<p>You can customize the behavior of each Toast using these options.</p>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>html</td>
<td>String</td>
<td>''</td>
<td>The HTML content of the Toast.</td>
</tr>
<tr>
<td>displayLength</td>
<td>Number</td>
<td>4000</td>
<td>Length in ms the Toast stays before dismissal.</td>
</tr>
<tr>
<td>inDuration</td>
<td>Number</td>
<td>300</td>
<td>Transition in duration in milliseconds.</td>
</tr>
<tr>
<td>outDuration</td>
<td>Number</td>
<td>375</td>
<td>Transition out duration in milliseconds.</td>
</tr>
<tr>
<td>classes</td>
<td>String</td>
<td>''</td>
<td>Classes to be added to the toast element.</td>
</tr>
<tr>
<td>completeCallback</td>
<td>Function</td>
<td>null</td>
<td>Callback function called when toast is dismissed.</td>
</tr>
<tr>
<td>activationPercent</td>
<td>Number</td>
<td>0.8</td>
<td>The percentage of the toast's width it takes for a drag to dismiss a Toast.</td>
</tr>
</tbody>
</table>
<br>
</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 toast element.</td>
</tr>
<tr>
<td>options</td>
<td>Object</td>
<td>The options the instance was initialized with.</td>
</tr>
<tr>
<td>panning</td>
<td>Boolean</td>
<td>Describes the current pan state of the Toast.</td>
</tr>
<tr>
<td>timeRemaining</td>
<td>Number</td>
<td>The remaining amount of time in ms that the toast will stay before dismissal.</td>
</tr>
</tbody>
</table>
</div>
<div id="custom-html" class="section scrollspy">
<h3 class="header">Custom HTML</h3>
<p>You can pass in an HTML String as the first argument as well. Take a look at the example below, where we pass in text as well as a flat button. If you call an external function instead of in-line JavaScript, you will not need to escape quotation marks. </p>
<a class="waves-effect waves-light btn" onclick="displayCustomHTMLToast()">Toast with Action</a>
<pre><code class="language-javascript">
var toastHTML = '<span>I am toast content</span><button class="btn-flat toast-action">Undo</button>';
M.toast({html: toastHTML});
</code></pre>
</div>
<div id="callback" class="scrollspy section">
<h3 class="header">Callback</h3>
<p>You can have the toast callback a function when it has been dismissed.</p>
<a class="btn" onclick="M.toast({html: 'I am a toast', completeCallback: function(){alert('Your toast was dismissed')}})">Toast!</a>
<pre><code class="language-markup">
<a class="btn" onclick="M.toast({html: 'I am a toast', completeCallback: function(){alert('Your toast was dismissed')}})">Toast!</a>
</code></pre>
</div>
<div id="styling" class="scrollspy section">
<h3 class="header">Styling Toasts</h3>
<p>We've added the ability to customize your toasts easily. You can pass in classes as an optional parameter into the toast function. We've added a rounded class for you, but you can create your own CSS classes and apply them to toasts. Checkout out our full example below.</p>
<a class="waves-effect waves-light btn" onclick="M.toast({html: 'I am a toast!', classes: 'rounded'})">Round Toast!</a>
<pre><code class="language-javascript">
// 'rounded' is the class I'm applying to the toast
M.toast({html: 'I am a toast!', classes: 'rounded'});
</code></pre>
</div>
<div id="dismissal" class="scrollspy section">
<h3 class="header">Dismiss a Toast Programatically</h3>
<p>To remove a specific toast using JavaScript, access the <code class="language-javascript">M_Toast</code> toast HTML element and call the dismiss function</p>
<pre><code class="language-javascript">
// Get toast DOM Element, get instance, then call dismiss function
var toastElement = document.querySelector('.toast');
var toastInstance = M.Toast.getInstance(toastElement);
toastInstance.dismiss();
</code></pre>
<h5>Dismiss all Toasts</h5>
<pre><code class="language-javascript">
M.Toast.dismissAll();
</code></pre>
</div>
</div>
<!-- Table of Contents -->
<div class="col hide-on-small-only m3 xl3 offset-xl1">
<div class="toc-wrapper">
<div class="buysellads hide-on-small-only">
<!-- CarbonAds Zone Code -->
<script async type="text/javascript" src="https://cdn.carbonads.com/carbon.js?serve=CKYIK27J&placement=materializecss" id="_carbonads_js"></script>
</div>
<div style="height: 1px;">
<ul class="section table-of-contents">
<li><a href="toasts.html#introduction">Introduction</a></li>
<li><a href="toasts.html#options">Options</a></li>
<li><a href="toasts.html#properties">Properties</a></li>
<li><a href="toasts.html#custom-html">Custom HTML</a></li>
<li><a href="toasts.html#callback">Callback</a></li>
<li><a href="toasts.html#styling">Styling Toasts</a></li>
<li><a href="toasts.html#dismissal">Dismissing Toasts</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</main> <footer class="page-footer docs-footer">
<div class="container">
<div class="row" style="margin-bottom: 0;">
<div class="col s12 m10 offset-m1">
<div class="row">
<div class="col l4 s12">
<h5>Help Materialize Grow</h5>
<p class="grey-text text-darken-2">We hope you have enjoyed using Materialize and if you feel like it has helped you out and want to support the team you can help us by donating or backing us on Patreon. Any amount would help support and continue development on this project and is greatly appreciated.</p>
<a class="btn waves-effect waves-light red lighten-2" href="support-us.html">Support Us</a>
</div>
<div class="col l4 s12">
<h5>Join the Discussion</h5>
<p class="grey-text text-darken-2">We have a Gitter chat room set up where you can talk directly with us. Come in and discuss new features, future goals, general problems or questions, or anything else you can think of.</p>
<a class="btn waves-effect waves-light red lighten-2" target="_blank" href="https://gitter.im/Dogfalo/materialize">Chat</a>
</div>
<div class="col l4 s12" style="overflow: hidden;">
<h5>Connect</h5>
<iframe src="https://ghbtns.com/github-btn.html?user=dogfalo&repo=materialize&type=watch&count=true&size=large" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe>
<br>
<a href="https://twitter.com/MaterializeCSS" class="twitter-follow-button" data-show-count="true" data-size="large" data-dnt="true">Follow @MaterializeCSS</a>
<br>
<div class="g-follow" data-annotation="bubble" data-height="24" data-href="https://plus.google.com/108619793845925798422" data-rel="publisher"></div>
</div>
</div>
<div class="row">
<div class="col s12">
<h5>Patreon Sponsors</h5>
</div>
<div class="col s12">
<div class="patreon-footer-ad">
<a href="https://www.keycdn.com" target="_blank" rel="noopener">
<img src="https://s7.postimg.cc/qefeablln/keycdn.png" alt="KeyCDN">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://ironmansoftware.com/universal-dashboard" target="_blank" rel="noopener">
<img src="https://s7.postimg.cc/cnax82u2z/universal-dashboard.png" alt="Universal Dashboard">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://www.spaculus.org/?s=p" target="_blank" rel="noopener">
<img src="https://s8.postimg.cc/vigwx9a0l/spaculus-logo.png" alt="Spaculus">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://wrappixel.com/" target="_blank" rel="noopener">
<img src="https://s14.postimg.cc/6u3tdxw81/wrappixel-logo.jpg" alt="WrapPixel">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://cryptoefx.com" target="_blank" rel="noopener">
<img src="https://s14.postimg.cc/gs1o4wy29/crypto-_EFX.png" alt="crypto EFX">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://webdock.io/en" target="_blank" rel="noopener">
<img src="https://s15.postimg.cc/3k2228kcb/ezgif.com-gif-maker.png" alt="Webdock">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://cryptapi.io" target="_blank" rel="noopener">
<img src="https://s15.postimg.cc/nmkoqq84r/white_bg.png" alt="CryptAPI">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://hostpresto.com/?utm_source=materializecss" target="_blank" rel="noopener">
<img src="https://s15.postimg.cc/4hhfhcyq3/hostpresto.png" alt="HostPresto">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://www.seareach.plc.uk/" target="_blank" rel="noopener">
<img src="https://s15.postimg.cc/6cqo8j30r/Seareach_LOGO_4_COL.png" alt="Seareach">
</a>
</div>
<div class="patreon-footer-ad">
<a href="http://lucidocean.com" target="_blank" rel="noopener">
<img src="https://s8.postimg.cc/762csselh/logo_full_size.png" alt="Lucid Ocean">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://www.stillio.com/" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/hcpyykzbr/stillio-as-logo-1000-green.png" title="Capture and archive website screenshots automatically with Stillio" alt="Capture and archive website screenshots automatically with Stillio">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://gaggle.email/" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/oqns3tzmf/gaggle-mail-logo.png" alt="Gaggle Mail">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://icons8.com/material-icons" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/q0lliz153/icons8-logo-opencollective.png" alt="Icons8">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://keymedium.com" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/m9c0wcpxz/2017-10-23-logo-refresh.png" alt="Philadelphia Web Design & SEO Agency">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://www.brandnewweb.nl" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/3pxqiuqyf/brandnewweb.png" alt="Brand New Web">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://typestack.nl" target="_blank" rel="noopener">
<img src="https://s13.postimg.cc/6k0vwalev/typestack.png" alt="Open source fully loaded CMS in #2019">
</a>
</div>
<div class="patreon-footer-ad">
<a href="https://www.yourlabs.biz" target="_blank" rel="noopener">
<img src="https://avatars0.githubusercontent.com/u/1040547?s=200&v=4" alt="YourLabs Business Service: Digital Strategy Consulting" title="YourLabs Business Service: Digital Strategy Consulting">
</a>
</div>
</div>
</div>
<div class="footer-copyright">
© 2014-<noscript>2018</noscript><script type="text/javascript">document.write(new Date().getFullYear());</script> Materialize, All rights reserved.
<a class="grey-text text-darken-1 right" href="https://github.com/Dogfalo/materialize/blob/master/LICENSE">MIT License</a>
</div>
</div>
</div>
</div>
</footer>
<!-- Scripts-->
<script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
<script>if (!window.jQuery) { document.write('<script src="https://materializecss.com/bin/jquery-3.2.1.min.js"><\/script>'); }
</script>
<script src="docs/js/jquery.timeago.min.js"></script>
<script src="docs/js/prism.js"></script>
<script src="docs/js/lunr.min.js"></script>
<script src="docs/js/search.js"></script>
<script src="js/materialize.js"></script>
<script src="docs/js/init.js"></script>
<!-- Twitter Button -->
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<!-- Google Plus Button-->
<script src="https://apis.google.com/js/platform.js" async defer></script>
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-56218128-1', 'auto');
ga('require', 'displayfeatures');
ga('send', 'pageview');
</script>
</body>
<script type="text/javascript">
var displayCustomHTMLToast = function () {
var toastHTML = '<span>I am toast content</span><button class="btn-flat toast-action">Undo</button>';
M.toast({html: toastHTML});
}
</script>
</html>