Toast
Push-Benachrichtigungen an Ihre Besucher mit einem Toast, einer leichten und leicht anpassbaren Warnmeldung.
Toasts sind einfache Benachrichtigungen, die die Push-Benachrichtigungen nachahmen sollen, die von Mobil- und Desktop-Betriebssystemen populär gemacht wurden. Sie sind mit Flexbox gebaut, sodass sie einfach auszurichten und zu positionieren sind.
Überblick
Wissenswertes zur Verwendung des Toast-Plugins:
- Toasts sind aus Leistungsgründen optional, daher müssen Sie sie selbst initialisieren .
- Toasts werden automatisch ausgeblendet, wenn Sie nicht angeben
autohide: false
.
prefers-reduced-motion
Medienanfrage. Weitere Informationen finden Sie im Abschnitt zur
reduzierten Bewegung in unserer Dokumentation zur Barrierefreiheit .
Beispiele
Basic
Um erweiterbare und vorhersehbare Toasts zu fördern, empfehlen wir einen Header und einen Body. Toast-Header verwenden display: flex
, was dank unserer Rand- und Flexbox-Dienstprogramme eine einfache Ausrichtung des Inhalts ermöglicht.
Toasts sind so flexibel wie Sie es brauchen und haben nur sehr wenig erforderliches Markup. Wir verlangen mindestens ein einzelnes Element, das Ihren „gerösteten“ Inhalt enthält, und empfehlen dringend eine Schaltfläche zum Schließen.
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small>11 mins ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
.hide
Klasse dynamisch hinzugefügt, um einen Toast vollständig auszublenden (mit
display:none
statt nur mit
opacity:0
). Dies ist nun nicht mehr notwendig. Aus Gründen der Abwärtskompatibilität wird unser Skript die Klasse jedoch bis zur nächsten Hauptversion weiter umschalten (obwohl es keinen praktischen Bedarf dafür gibt).
Live-Beispiel
Klicken Sie auf die Schaltfläche unten, um einen Toast anzuzeigen (positioniert mit unseren Dienstprogrammen in der unteren rechten Ecke), der standardmäßig ausgeblendet wurde.
<button type="button" class="btn btn-primary" id="liveToastBtn">Show live toast</button>
<div class="position-fixed bottom-0 end-0 p-3" style="z-index: 11">
<div id="liveToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small>11 mins ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
</div>
Wir verwenden das folgende JavaScript, um unsere Live-Toast-Demo auszulösen:
var toastTrigger = document.getElementById('liveToastBtn')
var toastLiveExample = document.getElementById('liveToast')
if (toastTrigger) {
toastTrigger.addEventListener('click', function () {
var toast = new bootstrap.Toast(toastLiveExample)
toast.show()
})
}
Durchscheinend
Toasts sind leicht durchscheinend, um mit dem, was darunter liegt, zu verschmelzen.
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small class="text-muted">11 mins ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
Stapeln
Sie können Toasts stapeln, indem Sie sie in einen Toastbehälter wickeln, wodurch vertikal etwas Abstand entsteht.
<div class="toast-container">
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small class="text-muted">just now</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></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">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small class="text-muted">2 seconds ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Heads up, toasts will stack automatically
</div>
</div>
</div>
Benutzerdefinierte Inhalte
Passen Sie Ihre Toasts an, indem Sie Unterkomponenten entfernen, sie mit Dienstprogrammen optimieren oder Ihr eigenes Markup hinzufügen. Hier haben wir einen einfacheren Toast erstellt .toast-header
, indem wir den Standard entfernt, ein benutzerdefiniertes Symbol zum Ausblenden von Bootstrap Icons hinzugefügt und einige Flexbox-Dienstprogramme zum Anpassen des Layouts verwendet haben.
<div class="toast align-items-center" role="alert" aria-live="assertive" aria-atomic="true">
<div class="d-flex">
<div class="toast-body">
Hello, world! This is a toast message.
</div>
<button type="button" class="btn-close me-2 m-auto" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
</div>
Alternativ können Sie Toasts auch zusätzliche Steuerelemente und Komponenten hinzufügen.
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-body">
Hello, world! This is a toast message.
<div class="mt-2 pt-2 border-top">
<button type="button" class="btn btn-primary btn-sm">Take action</button>
<button type="button" class="btn btn-secondary btn-sm" data-bs-dismiss="toast">Close</button>
</div>
</div>
</div>
Farbschemata
Aufbauend auf dem obigen Beispiel können Sie mit unseren Farb- und Hintergrunddienstprogrammen verschiedene Toast-Farbschemata erstellen . Hier haben wir .bg-primary
und .text-white
zum .toast
, und dann .btn-close-white
zu unserer Schließen-Schaltfläche hinzugefügt. Für einen scharfen Rand entfernen wir den Standardrand mit .border-0
.
<div class="toast align-items-center text-white bg-primary border-0" role="alert" aria-live="assertive" aria-atomic="true">
<div class="d-flex">
<div class="toast-body">
Hello, world! This is a toast message.
</div>
<button type="button" class="btn-close btn-close-white me-2 m-auto" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
</div>
Platzierung
Platzieren Sie Toasts mit benutzerdefiniertem CSS nach Bedarf. Oben rechts wird oft für Benachrichtigungen verwendet, ebenso oben in der Mitte. Wenn Sie immer nur einen Toast auf einmal anzeigen möchten, platzieren Sie die Positionierungsstile direkt auf dem .toast
.
<form>
<div class="mb-3">
<label for="selectToastPlacement">Toast placement</label>
<select class="form-select mt-2" id="selectToastPlacement">
<option value="" selected>Select a position...</option>
<option value="top-0 start-0">Top left</option>
<option value="top-0 start-50 translate-middle-x">Top center</option>
<option value="top-0 end-0">Top right</option>
<option value="top-50 start-0 translate-middle-y">Middle left</option>
<option value="top-50 start-50 translate-middle">Middle center</option>
<option value="top-50 end-0 translate-middle-y">Middle right</option>
<option value="bottom-0 start-0">Bottom left</option>
<option value="bottom-0 start-50 translate-middle-x">Bottom center</option>
<option value="bottom-0 end-0">Bottom right</option>
</select>
</div>
</form>
<div aria-live="polite" aria-atomic="true" class="bg-dark position-relative bd-example-toasts">
<div class="toast-container position-absolute p-3" id="toastPlacement">
<div class="toast">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small>11 mins ago</small>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
</div>
</div>
Erwägen Sie für Systeme, die mehr Benachrichtigungen generieren, die Verwendung eines Wrapping-Elements, damit sie sich problemlos stapeln lassen.
<div aria-live="polite" aria-atomic="true" class="position-relative">
<!-- Position it: -->
<!-- - `.toast-container` for spacing between toasts -->
<!-- - `.position-absolute`, `top-0` & `end-0` to position the toasts in the upper right corner -->
<!-- - `.p-3` to prevent the toasts from sticking to the edge of the container -->
<div class="toast-container position-absolute top-0 end-0 p-3">
<!-- Then put toasts within -->
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small class="text-muted">just now</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></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">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small class="text-muted">2 seconds ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Heads up, toasts will stack automatically
</div>
</div>
</div>
</div>
Sie können sich auch mit Flexbox-Dienstprogrammen austoben, um Toasts horizontal und/oder vertikal auszurichten.
<!-- Flexbox container for aligning the toasts -->
<div aria-live="polite" aria-atomic="true" class="d-flex justify-content-center align-items-center w-100">
<!-- Then put toasts within -->
<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small>11 mins ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
</div>
Barrierefreiheit
Toasts sind als kleine Unterbrechungen für Ihre Besucher oder Benutzer gedacht. Um Benutzern mit Screenreadern und ähnlichen Hilfstechnologien zu helfen, sollten Sie Ihre Toasts in einen aria-live
Bereich einschließen . Änderungen an Live-Bereichen (z. B. das Einfügen/Aktualisieren einer Toast-Komponente) werden automatisch von Bildschirmleseprogrammen angekündigt, ohne dass der Fokus des Benutzers verschoben oder der Benutzer anderweitig unterbrochen werden muss. Stellen aria-atomic="true"
Sie außerdem sicher, dass der gesamte Toast immer als eine einzelne (atomare) Einheit angekündigt wird, anstatt nur die Änderungen anzukündigen (was zu Problemen führen kann, wenn Sie nur einen Teil des Inhalts des Toasts aktualisieren oder denselben Toast-Inhalt anzeigen zu einem späteren Zeitpunkt). Wenn die benötigten Informationen für den Prozess wichtig sind, zB für eine Fehlerliste in einem Formular, dann nutzen Sie die Alert-Komponentestatt Toast.
Beachten Sie, dass die Live-Region im Markup vorhanden sein muss, bevor der Toast generiert oder aktualisiert wird. Wenn Sie beide gleichzeitig dynamisch generieren und in die Seite einfügen, werden sie in der Regel nicht von Hilfstechnologien angekündigt.
Je nach Inhalt müssen Sie auch die role
und Ebene anpassen . aria-live
Wenn es sich um eine wichtige Nachricht wie einen Fehler handelt, verwenden Sie role="alert" aria-live="assertive"
, andernfalls verwenden Sie role="status" aria-live="polite"
Attribute.
Wenn sich der angezeigte Inhalt ändert, stellen Sie sicher, dass Sie das delay
Zeitlimit aktualisieren , damit die Benutzer genügend Zeit haben, den Toast zu lesen.
<div class="toast" role="alert" aria-live="polite" aria-atomic="true" data-bs-delay="10000">
<div role="alert" aria-live="assertive" aria-atomic="true">...</div>
</div>
Wenn Sie verwenden autohide: false
, müssen Sie eine Schließen-Schaltfläche hinzufügen, damit Benutzer den Toast verwerfen können.
<div role="alert" aria-live="assertive" aria-atomic="true" class="toast" data-bs-autohide="false">
<div class="toast-header">
<img src="..." class="rounded me-2" alt="...">
<strong class="me-auto">Bootstrap</strong>
<small>11 mins ago</small>
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
</div>
<div class="toast-body">
Hello, world! This is a toast message.
</div>
</div>
Obwohl es technisch möglich ist, Ihrem Toast fokussierbare/umsetzbare Steuerelemente (z. B. zusätzliche Schaltflächen oder Links) hinzuzufügen, sollten Sie dies beim automatischen Ausblenden von Toasts vermeiden. Selbst wenn Sie dem Toast ein langes delay
Timeout geben , können Tastatur- und Hilfstechnologiebenutzer es schwierig finden, den Toast rechtzeitig zu erreichen, um Maßnahmen zu ergreifen (da Toasts keinen Fokus erhalten, wenn sie angezeigt werden). Wenn Sie unbedingt weitere Steuerelemente benötigen, empfehlen wir die Verwendung eines Toasts mit autohide: false
.
Sass
Variablen
$toast-max-width: 350px;
$toast-padding-x: .75rem;
$toast-padding-y: .5rem;
$toast-font-size: .875rem;
$toast-color: null;
$toast-background-color: rgba($white, .85);
$toast-border-width: 1px;
$toast-border-color: rgba($black, .1);
$toast-border-radius: $border-radius;
$toast-box-shadow: $box-shadow;
$toast-spacing: $container-padding-x;
$toast-header-color: $gray-600;
$toast-header-background-color: rgba($white, .85);
$toast-header-border-color: rgba($black, .05);
Verwendungszweck
Toasts über JavaScript initialisieren:
var toastElList = [].slice.call(document.querySelectorAll('.toast'))
var toastList = toastElList.map(function (toastEl) {
return new bootstrap.Toast(toastEl, option)
})
Löst aus
Die Entlassung kann mit dem data
Attribut auf einer Schaltfläche innerhalb des Toasts erreicht werden, wie unten gezeigt:
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
oder auf einer Schaltfläche außerhalb des Toasts , indem Sie data-bs-target
wie unten gezeigt Folgendes verwenden:
<button type="button" class="btn-close" data-bs-dismiss="toast" data-bs-target="#my-toast" aria-label="Close"></button>
Optionen
Optionen können über Datenattribute oder JavaScript übergeben werden. Hängen Sie für Datenattribute den Optionsnamen an data-bs-
, wie in data-bs-animation=""
.
Name | Typ | Standard | Beschreibung |
---|---|---|---|
animation |
boolesch | true |
Wenden Sie einen CSS-Fade-Übergang auf den Toast an |
autohide |
boolesch | true |
Toast automatisch ausblenden |
delay |
Nummer | 5000 |
Verzögerung beim Ausblenden des Toasts (ms) |
Methoden
Asynchrone Methoden und Übergänge
Alle API-Methoden sind asynchron und starten einen Übergang . Sie kehren zum Aufrufer zurück, sobald der Übergang gestartet wird, aber bevor er endet . Außerdem wird ein Methodenaufruf einer Übergangskomponente ignoriert .
Weitere Informationen finden Sie in unserer JavaScript-Dokumentation .
Show
Zeigt den Toast eines Elements an. Kehrt zum Anrufer zurück, bevor der Toast tatsächlich gezeigt wurde (dh bevor das shown.bs.toast
Ereignis eintritt). Sie müssen diese Methode manuell aufrufen, stattdessen wird Ihr Toast nicht angezeigt.
toast.show()
ausblenden
Blendet den Toast eines Elements aus. Kehrt zum Anrufer zurück, bevor der Toast tatsächlich ausgeblendet wurde (dh bevor das hidden.bs.toast
Ereignis eintritt). Sie müssen diese Methode manuell aufrufen, wenn Sie dies vorgenommen autohide
haben false
.
toast.hide()
entsorgen
Blendet den Toast eines Elements aus. Ihr Toast bleibt auf dem DOM, wird aber nicht mehr angezeigt.
toast.dispose()
bekomme Instanz
Statische Methode, mit der Sie die Toastinstanz abrufen können, die einem DOM-Element zugeordnet ist
var myToastEl = document.getElementById('myToastEl')
var myToast = bootstrap.Toast.getInstance(myToastEl) // Returns a Bootstrap toast instance
getOrCreateInstance
Statische Methode, mit der Sie die mit einem DOM-Element verknüpfte Toastinstanz abrufen oder eine neue erstellen können, falls sie nicht initialisiert wurde
var myToastEl = document.getElementById('myToastEl')
var myToast = bootstrap.Toast.getOrCreateInstance(myToastEl) // Returns a Bootstrap toast instance
Veranstaltungen
Ereignistyp | Beschreibung |
---|---|
show.bs.toast |
Dieses Ereignis wird sofort ausgelöst, wenn die show Instanzmethode aufgerufen wird. |
shown.bs.toast |
Dieses Ereignis wird ausgelöst, wenn der Toast für den Benutzer sichtbar gemacht wurde. |
hide.bs.toast |
Dieses Ereignis wird sofort ausgelöst, wenn die hide Instanzmethode aufgerufen wurde. |
hidden.bs.toast |
Dieses Ereignis wird ausgelöst, wenn der Toast vollständig vor dem Benutzer ausgeblendet wurde. |
var myToastEl = document.getElementById('myToast')
myToastEl.addEventListener('hidden.bs.toast', function () {
// do something...
})