mirror of
https://github.com/twbs/bootstrap.git
synced 2025-02-03 01:52:19 +01:00
789 lines
69 KiB
HTML
789 lines
69 KiB
HTML
|
<!doctype html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
||
|
|
<meta name="description" content="Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.">
|
||
|
|
<meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors">
|
||
|
|
<meta name="generator" content="Hugo 0.80.0">
|
||
|
|
|
||
|
|
<meta name="docsearch:language" content="en">
|
||
|
|
<meta name="docsearch:version" content="4.6">
|
||
|
|
|
||
|
|
<title>Toasts · Bootstrap v4.6</title>
|
||
|
|
|
||
|
|
<link rel="canonical" href="https://getbootstrap.com/docs/4.6/components/toasts/">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Bootstrap core CSS -->
|
||
|
|
<link href="/docs/4.6/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-B0vP5xmATw1+K9KRQjQERJvTumQW0nPEzvF6L/Z6nronJ3oUOFUFpCjEUQouq2+l" crossorigin="anonymous">
|
||
|
|
|
||
|
|
<!-- Documentation extras -->
|
||
|
|
<link href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" rel="stylesheet">
|
||
|
|
|
||
|
|
<link href="/docs/4.6/assets/css/docs.css" rel="stylesheet">
|
||
|
|
|
||
|
|
<!-- Favicons -->
|
||
|
|
<link rel="apple-touch-icon" href="/docs/4.6/assets/img/favicons/apple-touch-icon.png" sizes="180x180">
|
||
|
|
<link rel="icon" href="/docs/4.6/assets/img/favicons/favicon-32x32.png" sizes="32x32" type="image/png">
|
||
|
|
<link rel="icon" href="/docs/4.6/assets/img/favicons/favicon-16x16.png" sizes="16x16" type="image/png">
|
||
|
|
<link rel="manifest" href="/docs/4.6/assets/img/favicons/manifest.json">
|
||
|
|
<link rel="mask-icon" href="/docs/4.6/assets/img/favicons/safari-pinned-tab.svg" color="#563d7c">
|
||
|
|
<link rel="icon" href="/docs/4.6/assets/img/favicons/favicon.ico">
|
||
|
|
<meta name="msapplication-config" content="/docs/4.6/assets/img/favicons/browserconfig.xml">
|
||
|
|
<meta name="theme-color" content="#563d7c">
|
||
|
|
|
||
|
|
<!-- Twitter -->
|
||
|
|
<meta name="twitter:card" content="summary">
|
||
|
|
<meta name="twitter:site" content="@getbootstrap">
|
||
|
|
<meta name="twitter:creator" content="@getbootstrap">
|
||
|
|
<meta name="twitter:title" content="Toasts">
|
||
|
|
<meta name="twitter:description" content="Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.">
|
||
|
|
<meta name="twitter:image" content="https://getbootstrap.com/docs/4.6/assets/brand/bootstrap-social-logo.png">
|
||
|
|
|
||
|
|
<!-- Facebook -->
|
||
|
|
<meta property="og:url" content="https://getbootstrap.com/docs/4.6/components/toasts/">
|
||
|
|
<meta property="og:title" content="Toasts">
|
||
|
|
<meta property="og:description" content="Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.">
|
||
|
|
<meta property="og:type" content="article">
|
||
|
|
<meta property="og:image" content="https://getbootstrap.com/docs/4.6/assets/brand/bootstrap-social.png">
|
||
|
|
<meta property="og:image:type" content="image/png">
|
||
|
|
<meta property="og:image:width" content="1200">
|
||
|
|
<meta property="og:image:height" content="630">
|
||
|
|
|
||
|
|
<script>
|
||
|
|
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
||
|
|
ga('create', 'UA-146052-10', 'getbootstrap.com');
|
||
|
|
ga('set', 'anonymizeIp', true);
|
||
|
|
ga('send', 'pageview');
|
||
|
|
</script>
|
||
|
|
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="skippy overflow-hidden">
|
||
|
|
<div class="container-xl">
|
||
|
|
<a class="sr-only sr-only-focusable d-inline-flex p-2 m-1" href="#content">Skip to main content</a>
|
||
|
|
<a class="sr-only sr-only-focusable d-none d-md-inline-flex p-2 m-1" href="#bd-docs-nav">Skip to docs navigation</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<header class="navbar navbar-expand navbar-dark flex-column flex-md-row bd-navbar">
|
||
|
|
<a class="navbar-brand mr-0 mr-md-2" href="/" aria-label="Bootstrap">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" class="d-block" viewBox="0 0 612 612" role="img" focusable="false"><title>Bootstrap</title><path fill="currentColor" d="M510 8a94.3 94.3 0 0 1 94 94v408a94.3 94.3 0 0 1-94 94H102a94.3 94.3 0 0 1-94-94V102a94.3 94.3 0 0 1 94-94h408m0-8H102C45.9 0 0 45.9 0 102v408c0 56.1 45.9 102 102 102h408c56.1 0 102-45.9 102-102V102C612 45.9 566.1 0 510 0z"/><path fill="currentColor" d="M196.77 471.5V154.43h124.15c54.27 0 91 31.64 91 79.1 0 33-24.17 63.72-54.71 69.21v1.76c43.07 5.49 70.75 35.82 70.75 78 0 55.81-40 89-107.45 89zm39.55-180.4h63.28c46.8 0 72.29-18.68 72.29-53 0-31.42-21.53-48.78-60-48.78h-75.57zm78.22 145.46c47.68 0 72.73-19.34 72.73-56s-25.93-55.37-76.46-55.37h-74.49v111.4z"/></svg>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div class="navbar-nav-scroll">
|
||
|
|
<ul class="navbar-nav bd-navbar-nav flex-row">
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Bootstrap');">Home</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link active" href="/docs/4.6/getting-started/introduction/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Docs');">Documentation</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="/docs/4.6/examples/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Examples');">Examples</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="https://icons.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Icons');" target="_blank" rel="noopener">Icons</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="https://themes.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Themes');" target="_blank" rel="noopener">Themes</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="https://expo.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Expo');" target="_blank" rel="noopener">Expo</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link" href="https://blog.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Blog');" target="_blank" rel="noopener">Blog</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul class="navbar-nav ml-md-auto">
|
||
|
|
<li class="nav-item dropdown">
|
||
|
|
<a class="nav-item nav-link dropdown-toggle mr-md-2" href="#" id="bd-versions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
||
|
|
v4.6
|
||
|
|
</a>
|
||
|
|
<div class="dropdown-menu dropdown-menu-md-right" aria-labelledby="bd-versions">
|
||
|
|
<a class="dropdown-item active" href="/docs/4.6/">Latest (4.6.x)</a>
|
||
|
|
<div class="dropdown-divider"></div>
|
||
|
|
<a class="dropdown-item" href="https://getbootstrap.com/docs/5.0/">5.0.x</a>
|
||
|
|
<div class="dropdown-divider"></div>
|
||
|
|
<a class="dropdown-item" href="https://getbootstrap.com/docs/3.4/">v3.4.1</a>
|
||
|
|
<a class="dropdown-item" href="https://getbootstrap.com/2.3.2/">v2.3.2</a>
|
||
|
|
<div class="dropdown-divider"></div>
|
||
|
|
<a class="dropdown-item" href="/docs/versions/">All versions</a>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link pl-2 pr-1 mx-1 py-3 my-n2" href="https://github.com/twbs" target="_blank" rel="noopener" aria-label="GitHub">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link px-1 mx-1 py-3 my-n2" href="https://twitter.com/getbootstrap" target="_blank" rel="noopener" aria-label="Twitter">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link px-1 mx-1 py-3 my-n2" href="https://bootstrap-slack.herokuapp.com/" target="_blank" rel="noopener" aria-label="Slack">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 512" role="img" focusable="false"><title>Slack</title><path fill="currentColor" d="M210.787 234.832l68.31-22.883 22.1 65.977-68.309 22.882z"/><path fill="currentColor" d="M490.54 185.6C437.7 9.59 361.6-31.34 185.6 21.46S-31.3 150.4 21.46 326.4 150.4 543.3 326.4 490.54 543.34 361.6 490.54 185.6zM401.7 299.8l-33.15 11.05 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.38-68.36 22.92 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.43-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.5-13.92 2.87-29.06 16.78-33.56l33.12-11.03-22.1-65.9-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.48-13.93 2.89-29.07 16.81-33.58l33.15-11.05-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.46 34.38 68.36-22.92-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.47 34.42 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.87 29.06-16.78 33.56L329.7 194.6l22.1 65.9 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.88 29.07-16.81 33.57z"/></svg>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-item">
|
||
|
|
<a class="nav-link px-1 mx-1 py-3 my-n2" href="https://opencollective.com/bootstrap/" target="_blank" rel="noopener" aria-label="Open Collective">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" fill-rule="evenodd" class="navbar-nav-svg" viewBox="0 0 40 41" role="img" focusable="false"><title>Open Collective</title><path fill-opacity=".4" d="M32.8 21c0 2.4-.8 4.9-2 6.9l5.1 5.1c2.5-3.4 4.1-7.6 4.1-12 0-4.6-1.6-8.8-4-12.2L30.7 14c1.2 2 2 4.3 2 7z"/><path d="M20 33.7a12.8 12.8 0 0 1 0-25.6c2.6 0 5 .7 7 2.1L32 5a20 20 0 1 0 .1 31.9l-5-5.2a13 13 0 0 1-7 2z"/></svg>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<a class="btn btn-bd-download d-none d-lg-inline-block mb-3 mb-md-0 ml-md-3" href="/docs/4.6/getting-started/download/">Download</a>
|
||
|
|
</header>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="container-fluid">
|
||
|
|
<div class="row flex-xl-nowrap">
|
||
|
|
<div class="col-md-3 col-xl-2 bd-sidebar">
|
||
|
|
<form role="search" class="bd-search d-flex align-items-center">
|
||
|
|
<input type="search" class="form-control" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off" data-docs-version="4.6">
|
||
|
|
<button class="btn bd-search-docs-toggle d-md-none p-0 ml-3" type="button" data-toggle="collapse" data-target="#bd-docs-nav" aria-controls="bd-docs-nav" aria-expanded="false" aria-label="Toggle docs navigation">
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"/></svg>
|
||
|
|
</button>
|
||
|
|
</form>
|
||
|
|
|
||
|
|
<div class="collapse d-md-block row" id="bd-docs-nav">
|
||
|
|
<nav class="bd-links" aria-label="Main navigation">
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/getting-started/introduction/">
|
||
|
|
Getting started
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/layout/overview/">
|
||
|
|
Layout
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/content/reboot/">
|
||
|
|
Content
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item active">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/components/alerts/">
|
||
|
|
Components
|
||
|
|
</a>
|
||
|
|
<ul class="nav bd-sidenav">
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/alerts/">Alerts</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/badge/">Badge</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/breadcrumb/">Breadcrumb</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/buttons/">Buttons</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/button-group/">Button group</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/card/">Card</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/carousel/">Carousel</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/collapse/">Collapse</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/dropdowns/">Dropdowns</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/forms/">Forms</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/input-group/">Input group</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/jumbotron/">Jumbotron</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/list-group/">List group</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/media-object/">Media object</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/modal/">Modal</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/navs/">Navs</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/navbar/">Navbar</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/pagination/">Pagination</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/popovers/">Popovers</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/progress/">Progress</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/scrollspy/">Scrollspy</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/spinners/">Spinners</a>
|
||
|
|
</li>
|
||
|
|
<li class="active bd-sidenav-active">
|
||
|
|
<a href="/docs/4.6/components/toasts/">Toasts</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="/docs/4.6/components/tooltips/">Tooltips</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/utilities/borders/">
|
||
|
|
Utilities
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/extend/approach/">
|
||
|
|
Extend
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/migration/">
|
||
|
|
Migration
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="bd-toc-item">
|
||
|
|
<a class="bd-toc-link" href="/docs/4.6/about/overview/">
|
||
|
|
About
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="d-none d-xl-block col-xl-2 bd-toc" aria-label="Secondary navigation">
|
||
|
|
<nav id="TableOfContents">
|
||
|
|
<ul>
|
||
|
|
<li><a href="#overview">Overview</a></li>
|
||
|
|
<li><a href="#examples">Examples</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#basic">Basic</a></li>
|
||
|
|
<li><a href="#live">Live</a></li>
|
||
|
|
<li><a href="#translucent">Translucent</a></li>
|
||
|
|
<li><a href="#stacking">Stacking</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#placement">Placement</a></li>
|
||
|
|
<li><a href="#accessibility">Accessibility</a></li>
|
||
|
|
<li><a href="#javascript-behavior">JavaScript behavior</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#usage">Usage</a></li>
|
||
|
|
<li><a href="#options">Options</a></li>
|
||
|
|
<li><a href="#methods">Methods</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#toastoptions"><code>$().toast(options)</code></a></li>
|
||
|
|
<li><a href="#toastshow"><code>.toast('show')</code></a></li>
|
||
|
|
<li><a href="#toasthide"><code>.toast('hide')</code></a></li>
|
||
|
|
<li><a href="#toastdispose"><code>.toast('dispose')</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#events">Events</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
|
||
|
|
<main class="col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content" role="main">
|
||
|
|
<div class="d-md-flex flex-md-row-reverse align-items-center justify-content-between">
|
||
|
|
<a class="btn btn-sm btn-bd-light my-2 my-md-0" href="https://github.com/twbs/bootstrap/blob/v4-dev/site/content/docs/4.6/components/toasts.md" title="View and edit this file on GitHub" target="_blank" rel="noopener">View on GitHub</a>
|
||
|
|
<h1 class="bd-title" id="content">Toasts</h1>
|
||
|
|
</div>
|
||
|
|
<p class="bd-lead">Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.</p>
|
||
|
|
<script async src="https://cdn.carbonads.com/carbon.js?serve=CKYIKKJL&placement=getbootstrapcom" id="_carbonads_js"></script>
|
||
|
|
|
||
|
|
<p>Toasts are lightweight notifications designed to mimic the push notifications that have been popularized by mobile and desktop operating systems. They’re built with flexbox, so they’re easy to align and position.</p>
|
||
|
|
<h2 id="overview">Overview</h2>
|
||
|
|
<p>Things to know when using the toast plugin:</p>
|
||
|
|
<ul>
|
||
|
|
<li>If you’re building our JavaScript from source, it <a href="/docs/4.6/getting-started/javascript/#util">requires <code>util.js</code></a>.</li>
|
||
|
|
<li>Toasts are opt-in for performance reasons, so <strong>you must initialize them yourself</strong>.</li>
|
||
|
|
<li><strong>Please note that you are responsible for positioning toasts.</strong></li>
|
||
|
|
<li>Toasts will automatically hide if you do not specify <code>autohide: false</code>.</li>
|
||
|
|
</ul>
|
||
|
|
<div class="bd-callout bd-callout-info">
|
||
|
|
The animation effect of this component is dependent on the <code>prefers-reduced-motion</code> media query. See the <a href="/docs/4.6/getting-started/accessibility/#reduced-motion">reduced motion section of our accessibility documentation</a>.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h2 id="examples">Examples</h2>
|
||
|
|
<h3 id="basic">Basic</h3>
|
||
|
|
<p>To encourage extensible and predictable toasts, we recommend a header and body. Toast headers use <code>display: flex</code>, allowing easy alignment of content thanks to our margin and flexbox utilities.</p>
|
||
|
|
<p>Toasts are as flexible as you need and have very little required markup. At a minimum, we require a single element to contain your “toasted” content and strongly encourage a dismiss button.</p>
|
||
|
|
<div class="bd-example bg-light">
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small>11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<h3 id="live">Live</h3>
|
||
|
|
<p>Click the button the below to show as toast (positioning with our utilities in the lower right corner) that has been hidden by default with <code>.hide</code>.</p>
|
||
|
|
<div class="position-fixed bottom-0 right-0 p-3" style="z-index: 5; right: 0; bottom: 0;">
|
||
|
|
<div id="liveToast" class="toast hide" role="alert" aria-live="assertive" aria-atomic="true" data-delay="2000">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" preserveAspectRatio="xMidYMid slice" focusable="false"><rect width="100%" height="100%" fill="#007aff"/></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small>11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="bd-example">
|
||
|
|
<button type="button" class="btn btn-primary" id="liveToastBtn">Show live toast</button>
|
||
|
|
</div>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"btn btn-primary"</span> <span class="na">id</span><span class="o">=</span><span class="s">"liveToastBtn"</span><span class="p">></span>Show live toast<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"position-fixed bottom-0 right-0 p-3"</span> <span class="na">style</span><span class="o">=</span><span class="s">"z-index: 5; right: 0; bottom: 0;"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">id</span><span class="o">=</span><span class="s">"liveToast"</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast hide"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">data-delay</span><span class="o">=</span><span class="s">"2000"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
</code></pre></div><h3 id="translucent">Translucent</h3>
|
||
|
|
<p>Toasts are slightly translucent, too, so they blend over whatever they might appear over. For browsers that support the <code>backdrop-filter</code> CSS property, we’ll also attempt to blur the elements under a toast.</p>
|
||
|
|
<div class="bd-example bg-dark">
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small class="text-muted">11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span> <span class="na">class</span><span class="o">=</span><span class="s">"text-muted"</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<h3 id="stacking">Stacking</h3>
|
||
|
|
<p>When you have multiple toasts, we default to vertically stacking them in a readable manner.</p>
|
||
|
|
<div class="bd-example bg-light">
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small class="text-muted">just now</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
See? Just like this.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small class="text-muted">2 seconds ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Heads up, toasts will stack automatically
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span> <span class="na">class</span><span class="o">=</span><span class="s">"text-muted"</span><span class="p">></span>just now<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
See? Just like this.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span> <span class="na">class</span><span class="o">=</span><span class="s">"text-muted"</span><span class="p">></span>2 seconds ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Heads up, toasts will stack automatically
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<h2 id="placement">Placement</h2>
|
||
|
|
<p>Place toasts with custom CSS as you need them. The top right is often used for notifications, as is the top middle. If you’re only ever going to show one toast at a time, put the positioning styles right on the <code>.toast</code>.</p>
|
||
|
|
<div class="bd-example bg-dark">
|
||
|
|
<div aria-live="polite" aria-atomic="true" style="position: relative; min-height: 200px;">
|
||
|
|
<div class="toast" style="position: absolute; top: 0; right: 0;">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small>11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"polite"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">style</span><span class="o">=</span><span class="s">"position: relative; min-height: 200px;"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">style</span><span class="o">=</span><span class="s">"position: absolute; top: 0; right: 0;"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<p>For systems that generate more notifications, consider using a wrapping element so they can easily stack.</p>
|
||
|
|
<div class="bd-example bg-dark">
|
||
|
|
<div aria-live="polite" aria-atomic="true" style="position: relative; min-height: 200px;">
|
||
|
|
<!-- Position it -->
|
||
|
|
<div style="position: absolute; top: 0; right: 0;">
|
||
|
|
|
||
|
|
<!-- Then put toasts within -->
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small class="text-muted">just now</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
See? Just like this.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small class="text-muted">2 seconds ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Heads up, toasts will stack automatically
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"polite"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">style</span><span class="o">=</span><span class="s">"position: relative; min-height: 200px;"</span><span class="p">></span>
|
||
|
|
<span class="c"><!-- Position it --></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">style</span><span class="o">=</span><span class="s">"position: absolute; top: 0; right: 0;"</span><span class="p">></span>
|
||
|
|
|
||
|
|
<span class="c"><!-- Then put toasts within --></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span> <span class="na">class</span><span class="o">=</span><span class="s">"text-muted"</span><span class="p">></span>just now<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
See? Just like this.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span> <span class="na">class</span><span class="o">=</span><span class="s">"text-muted"</span><span class="p">></span>2 seconds ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Heads up, toasts will stack automatically
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<p>You can also get fancy with flexbox utilities to align toasts horizontally and/or vertically.</p>
|
||
|
|
<div class="bd-example bg-dark">
|
||
|
|
<!-- Flexbox container for aligning the toasts -->
|
||
|
|
<div aria-live="polite" aria-atomic="true" class="d-flex justify-content-center align-items-center" style="height: 200px;">
|
||
|
|
|
||
|
|
<!-- Then put toasts within -->
|
||
|
|
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small>11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="c"><!-- Flexbox container for aligning the toasts --></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"polite"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">class</span><span class="o">=</span><span class="s">"d-flex justify-content-center align-items-center"</span> <span class="na">style</span><span class="o">=</span><span class="s">"height: 200px;"</span><span class="p">></span>
|
||
|
|
|
||
|
|
<span class="c"><!-- Then put toasts within --></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<h2 id="accessibility">Accessibility</h2>
|
||
|
|
<p>Toasts are intended to be small interruptions to your visitors or users, so to help those with screen readers and similar assistive technologies, you should wrap your toasts in an <a href="https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions"><code>aria-live</code> region</a>. Changes to live regions (such as injecting/updating a toast component) are automatically announced by screen readers without needing to move the user’s focus or otherwise interrupt the user. Additionally, include <code>aria-atomic="true"</code> to ensure that the entire toast is always announced as a single (atomic) unit, rather than announcing what was changed (which could lead to problems if you only update part of the toast’s content, or if displaying the same toast content at a later point in time). If the information needed is important for the process, e.g. for a list of errors in a form, then use the <a href="/docs/4.6/components/alerts/">alert component</a> instead of toast.</p>
|
||
|
|
<p>Note that the live region needs to be present in the markup <em>before</em> the toast is generated or updated. If you dynamically generate both at the same time and inject them into the page, they will generally not be announced by assistive technologies.</p>
|
||
|
|
<p>You also need to adapt the <code>role</code> and <code>aria-live</code> level depending on the content. If it’s an important message like an error, use <code>role="alert" aria-live="assertive"</code>, otherwise use <code>role="status" aria-live="polite"</code> attributes.</p>
|
||
|
|
<p>As the content you’re displaying changes, be sure to update the <a href="#options"><code>delay</code> timeout</a> to ensure people have enough time to read the toast.</p>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"polite"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">data-delay</span><span class="o">=</span><span class="s">"10000"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span>...<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
</code></pre></div><p>When using <code>autohide: false</code>, you must add a close button to allow users to dismiss the toast.</p>
|
||
|
|
<div class="bd-example bg-light">
|
||
|
|
<div role="alert" aria-live="assertive" aria-atomic="true" class="toast" data-autohide="false">
|
||
|
|
<div class="toast-header">
|
||
|
|
<svg class="bd-placeholder-img rounded mr-2" width="20" height="20" xmlns="http://www.w3.org/2000/svg" role="img" aria-label=" : " preserveAspectRatio="xMidYMid slice" focusable="false"><title> </title><rect width="100%" height="100%" fill="#007aff"/><text x="50%" y="50%" fill="#dee2e6" dy=".3em"> </text></svg>
|
||
|
|
|
||
|
|
<strong class="mr-auto">Bootstrap</strong>
|
||
|
|
<small>11 mins ago</small>
|
||
|
|
<button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
|
||
|
|
<span aria-hidden="true">×</span>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
<div class="toast-body">
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><div class="highlight"><pre class="chroma"><code class="language-html" data-lang="html"><span class="p"><</span><span class="nt">div</span> <span class="na">role</span><span class="o">=</span><span class="s">"alert"</span> <span class="na">aria-live</span><span class="o">=</span><span class="s">"assertive"</span> <span class="na">aria-atomic</span><span class="o">=</span><span class="s">"true"</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">data-autohide</span><span class="o">=</span><span class="s">"false"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-header"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"..."</span> <span class="na">class</span><span class="o">=</span><span class="s">"rounded mr-2"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"..."</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">strong</span> <span class="na">class</span><span class="o">=</span><span class="s">"mr-auto"</span><span class="p">></span>Bootstrap<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">small</span><span class="p">></span>11 mins ago<span class="p"></</span><span class="nt">small</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">button</span> <span class="na">type</span><span class="o">=</span><span class="s">"button"</span> <span class="na">class</span><span class="o">=</span><span class="s">"ml-2 mb-1 close"</span> <span class="na">data-dismiss</span><span class="o">=</span><span class="s">"toast"</span> <span class="na">aria-label</span><span class="o">=</span><span class="s">"Close"</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">span</span> <span class="na">aria-hidden</span><span class="o">=</span><span class="s">"true"</span><span class="p">></span><span class="ni">&times;</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">button</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"toast-body"</span><span class="p">></span>
|
||
|
|
Hello, world! This is a toast message.
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
|
|
<span class="p"></</span><span class="nt">div</span><span class="p">></span></code></pre></div>
|
||
|
|
<h2 id="javascript-behavior">JavaScript behavior</h2>
|
||
|
|
<h3 id="usage">Usage</h3>
|
||
|
|
<p>Initialize toasts via JavaScript:</p>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.toast'</span><span class="p">).</span><span class="nx">toast</span><span class="p">(</span><span class="nx">option</span><span class="p">)</span>
|
||
|
|
</code></pre></div><h3 id="options">Options</h3>
|
||
|
|
<p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p>
|
||
|
|
<table class="table table-bordered table-striped">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th style="width: 100px;">Name</th>
|
||
|
|
<th style="width: 100px;">Type</th>
|
||
|
|
<th style="width: 50px;">Default</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>animation</td>
|
||
|
|
<td>boolean</td>
|
||
|
|
<td>true</td>
|
||
|
|
<td>Apply a CSS fade transition to the toast</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>autohide</td>
|
||
|
|
<td>boolean</td>
|
||
|
|
<td>true</td>
|
||
|
|
<td>Auto hide the toast</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>delay</td>
|
||
|
|
<td>number</td>
|
||
|
|
<td>
|
||
|
|
<code>500</code>
|
||
|
|
</td>
|
||
|
|
<td>Delay hiding the toast (ms)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3 id="methods">Methods</h3>
|
||
|
|
<div class="bd-callout bd-callout-danger">
|
||
|
|
<h4 id="asynchronous-methods-and-transitions">Asynchronous methods and transitions</h4>
|
||
|
|
<p>All API methods are <strong>asynchronous</strong> and start a <strong>transition</strong>. They return to the caller as soon as the transition is started but <strong>before it ends</strong>. In addition, a method call on a <strong>transitioning component will be ignored</strong>.</p>
|
||
|
|
<p><a href="/docs/4.6/getting-started/javascript/#asynchronous-functions-and-transitions">See our JavaScript documentation for more information</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h4 id="toastoptions"><code>$().toast(options)</code></h4>
|
||
|
|
<p>Attaches a toast handler to an element collection.</p>
|
||
|
|
<h4 id="toastshow"><code>.toast('show')</code></h4>
|
||
|
|
<p>Reveals an element’s toast. <strong>Returns to the caller before the toast has actually been shown</strong> (i.e. before the <code>shown.bs.toast</code> event occurs).
|
||
|
|
You have to manually call this method, instead your toast won’t show.</p>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">toast</span><span class="p">(</span><span class="s1">'show'</span><span class="p">)</span>
|
||
|
|
</code></pre></div><h4 id="toasthide"><code>.toast('hide')</code></h4>
|
||
|
|
<p>Hides an element’s toast. <strong>Returns to the caller before the toast has actually been hidden</strong> (i.e. before the <code>hidden.bs.toast</code> event occurs). You have to manually call this method if you made <code>autohide</code> to <code>false</code>.</p>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">toast</span><span class="p">(</span><span class="s1">'hide'</span><span class="p">)</span>
|
||
|
|
</code></pre></div><h4 id="toastdispose"><code>.toast('dispose')</code></h4>
|
||
|
|
<p>Hides an element’s toast. Your toast will remain on the DOM but won’t show anymore.</p>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#element'</span><span class="p">).</span><span class="nx">toast</span><span class="p">(</span><span class="s1">'dispose'</span><span class="p">)</span>
|
||
|
|
</code></pre></div><h3 id="events">Events</h3>
|
||
|
|
<table class="table table-bordered table-striped">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th style="width: 150px;">Event Type</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>show.bs.toast</td>
|
||
|
|
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>shown.bs.toast</td>
|
||
|
|
<td>This event is fired when the toast has been made visible to the user.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>hide.bs.toast</td>
|
||
|
|
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>hidden.bs.toast</td>
|
||
|
|
<td>This event is fired when the toast has finished being hidden from the user.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<div class="highlight"><pre class="chroma"><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myToast'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'hidden.bs.toast'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
||
|
|
<span class="c1">// do something...
|
||
|
|
</span><span class="c1"></span><span class="p">})</span>
|
||
|
|
</code></pre></div>
|
||
|
|
</main>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
|
||
|
|
<script>window.jQuery || document.write('<script src="/docs/4.6/assets/js/vendor/jquery.slim.min.js"><\/script>')</script>
|
||
|
|
|
||
|
|
<script src="/docs/4.6/dist/js/bootstrap.bundle.min.js" integrity="sha384-Piv4xVNRyMGpqkS2by6br4gNJ7DXjqk09RmUpJ8jgGtD7zP9yug3goQfGII0yAns" crossorigin="anonymous"></script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
||
|
|
|
||
|
|
<script src="/docs/4.6/assets/js/docs.min.js"></script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|