Paahtoleipää
Välitä ilmoituksia vierailijoille maljalla, kevyellä ja helposti muokattavalla hälytysviestillä.
Toastit ovat kevyitä ilmoituksia, jotka on suunniteltu jäljittelemään push-ilmoituksia, joita mobiili- ja työpöytäkäyttöjärjestelmät ovat suosineet. Ne on rakennettu flexboxilla, joten ne on helppo kohdistaa ja sijoittaa.
Yleiskatsaus
Asiat, jotka sinun tulee tietää käytettäessä toast-laajennusta:
- Paahtoleipäät ovat valittavissa suorituskykysyistä, joten sinun on alustettava ne itse .
- Toast piilotetaan automaattisesti, jos et määritä
autohide: false
.
prefers-reduced-motion
mediakyselystä. Katso
esteettömyysdokumentaation osio liikkeen vähentämisestä .
Esimerkkejä
Perus
Laajentuvien ja ennustettavien maljojen kannustamiseksi suosittelemme otsikkoa ja runkoa. Toast-otsikot käyttävät display: flex
, mikä mahdollistaa sisällön helpon kohdistamisen marginaali- ja flexbox-apuohjelmiemme ansiosta.
Toast ovat niin joustavia kuin tarvitset, ja niissä on hyvin vähän vaadittuja merkintöjä. Vaadimme vähintään yhden elementin, joka sisältää "paahdetun" sisällön, ja suosittelemme voimakkaasti hylkäämispainiketta.
<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
luokan dynaamisesti piilottaakseen paahtoleivän kokonaan (käteen
display:none
, ei vain -painikkeella
opacity:0
). Tämä ei ole enää tarpeen. Taaksepäin yhteensopivuuden vuoksi skriptimme jatkaa kuitenkin luokan vaihtamista (vaikka sille ei ole käytännön tarvetta) seuraavaan pääversioon asti.
Elävä esimerkki
Napsauta alla olevaa painiketta näyttääksesi paahtoleivän (joka on sijoitettu apuohjelmiemme oikeaan alakulmaan), joka on piilotettu oletuksena.
<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>
Käytämme seuraavaa JavaScriptiä live-toast-demon käynnistämiseen:
var toastTrigger = document.getElementById('liveToastBtn')
var toastLiveExample = document.getElementById('liveToast')
if (toastTrigger) {
toastTrigger.addEventListener('click', function () {
var toast = new bootstrap.Toast(toastLiveExample)
toast.show()
})
}
Läpikuultava
Paahtoleipä on hieman läpikuultava sulautuakseen alla olevaan.
<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>
Pinoaminen
Voit pinota paahtoleipää käärimällä ne paahtoleipäastiaan, mikä lisää pystysuunnassa väliä.
<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>
Mukautettu sisältö
Mukauta maljojasi poistamalla alikomponentteja, säätämällä niitä apuohjelmilla tai lisäämällä omia merkintöjäsi. Tässä olemme luoneet yksinkertaisemman maljan poistamalla oletusasetuksen .toast-header
, lisäämällä mukautetun piilotuskuvakkeen Bootstrap Iconsista ja käyttämällä joitain flexbox-apuohjelmia asettelun säätämiseen.
<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>
Vaihtoehtoisesti voit myös lisätä lisäsäätimiä ja komponentteja paahtoleipiin.
<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>
Värimallit
Yllä olevan esimerkin pohjalta voit luoda erilaisia paahtoleipien väriteemoja väri- ja taustaapuohjelmillamme . Tässä olemme lisänneet ja .bg-primary
-painikkeeseen ja sitten lisänneet sulje-painikkeeseen. Terävän reunan saamiseksi poistamme oletusreunuksen ..text-white
.toast
.btn-close-white
.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>
Sijoitus
Aseta paahtoleipää mukautetulla CSS:llä tarpeen mukaan. Oikeaa yläkulmaa käytetään usein ilmoituksiin, kuten myös keskimmäistä yläkulmaa. Jos aiot näyttää vain yhden maljan kerrallaan, aseta sijoittelutyylit suoraan .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>
Jos järjestelmä tuottaa enemmän ilmoituksia, harkitse kääreelementin käyttöä, jotta ne voivat pinota helposti.
<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>
Voit myös innostaa flexbox-apuohjelmia kohdistamaan paahtoleipää vaaka- ja/tai pystysuunnassa.
<!-- 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>
Esteettömyys
Paahtoleipien on tarkoitus olla pieniä häiriöitä vierailijoille tai käyttäjille, joten näytönlukuohjelmien ja vastaavien aputekniikoiden käyttäjiä varten sinun tulee kääriä maljasi aria-live
alueelle . Näytönlukijat ilmoittavat reaaliaikaisten alueiden muutoksista (kuten paahtoleipäkomponentin lisääminen/päivitys) automaattisesti ilman, että käyttäjän tarvitsee siirtää tarkennusta tai muuten keskeyttää käyttäjää. Lisää aria-atomic="true"
myös varmistaaksesi, että koko paahtoleipä ilmoitetaan aina yhtenä (atomi)yksikkönä sen sijaan, että ilmoitat vain, mitä on muutettu (mikä voi johtaa ongelmiin, jos päivität vain osan paahtoleivän sisällöstä tai jos näytät saman paahtoleivän sisällön myöhempänä ajankohtana). Jos tarvittavat tiedot ovat tärkeitä prosessille, esim. lomakkeen virheluetteloa varten, käytä hälytyskomponenttiapaahtoleivän sijasta.
Huomaa, että live-alueen on oltava mukana merkinnöissä ennen kuin paahtoleipä luodaan tai päivitetään. Jos luot molemmat dynaamisesti samanaikaisesti ja lisäät ne sivulle, aputekniikat eivät yleensä ilmoita niistä.
Sinun on myös mukautettava role
ja aria-live
tasoa sisällön mukaan. Jos se on tärkeä viesti, kuten virhe, käytä role="alert" aria-live="assertive"
, muussa tapauksessa role="status" aria-live="polite"
määritteitä.
Kun näytettävä sisältö muuttuu, muista päivittää delay
aikakatkaisu , jotta käyttäjillä on tarpeeksi aikaa lukea malja.
<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>
Kun käytät autohide: false
, sinun on lisättävä sulkemispainike, jotta käyttäjät voivat hylätä paahtoleivän.
<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>
Vaikka teknisesti on mahdollista lisätä tarkennettavia/toimivia säätimiä (kuten lisäpainikkeita tai linkkejä) paahtoleipääsi, sinun tulee välttää tämän tekemistä automaattisesti piilotettaessa paahtoleipää. Vaikka antaisit maljalle pitkän delay
aikakatkaisun , näppäimistön ja aputekniikan käyttäjien voi olla vaikea saavuttaa malja ajoissa ryhtyäkseen toimenpiteisiin (koska maljat eivät tarkenna, kun ne näytetään). Jos sinulla on ehdottomasti oltava lisäsäätimiä, suosittelemme käyttämään paahtoleipää, jossa on autohide: false
.
Sass
Muuttujat
$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);
Käyttö
Paahtoleipien alustaminen JavaScriptin avulla:
var toastElList = [].slice.call(document.querySelectorAll('.toast'))
var toastList = toastElList.map(function (toastEl) {
return new bootstrap.Toast(toastEl, option)
})
Liipaisimet
Irtisanominen voidaan saavuttaa maljan sisällä olevandata
painikkeen attribuutilla, kuten alla on esitetty:
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
tai painikkeella paahtoleivän ulkopuolella alla data-bs-target
kuvatulla tavalla:
<button type="button" class="btn-close" data-bs-dismiss="toast" data-bs-target="#my-toast" aria-label="Close"></button>
Vaihtoehdot
Vaihtoehdot voidaan välittää tietomääritteiden tai JavaScriptin kautta. Liitä tietomääritteissä vaihtoehdon nimi kohtaan data-bs-
, kuten kohdassa data-bs-animation=""
.
Nimi | Tyyppi | Oletus | Kuvaus |
---|---|---|---|
animation |
boolean | true |
Käytä CSS-häivytystä maljassa |
autohide |
boolean | true |
Piilota paahtoleipä automaattisesti |
delay |
määrä | 5000 |
Viive paahtoleivän piilottamista (ms) |
menetelmät
Asynkroniset menetelmät ja siirtymät
Kaikki API - menetelmät ovat asynkronisia ja aloittavat siirtymän . He palaavat soittajan luo heti siirtymisen alkaessa, mutta ennen sen päättymistä . Lisäksi siirtyvän komponentin menetelmäkutsu jätetään huomioimatta .
näytä
Paljastaa elementin paahtoleivän. Palaa soittajalle ennen kuin malja on todella esitetty (eli ennen shown.bs.toast
tapahtumaa). Sinun on kutsuttava tämä menetelmä manuaalisesti, sen sijaan paahtoleipäsi ei näy.
toast.show()
piilottaa
Piilottaa elementin paahtoleivän. Palaa soittajalle ennen kuin malja on todella piilotettu (eli ennen hidden.bs.toast
tapahtumaa). Sinun on kutsuttava tämä menetelmä manuaalisesti, jos olet autohide
tehnyt false
.
toast.hide()
hävittää
Piilottaa elementin paahtoleivän. Paahtoleipäsi pysyy DOM:ssa, mutta ei näy enää.
toast.dispose()
getInstance
Staattinen menetelmä, jonka avulla voit saada DOM-elementtiin liittyvän toast-instanssin
var myToastEl = document.getElementById('myToastEl')
var myToast = bootstrap.Toast.getInstance(myToastEl) // Returns a Bootstrap toast instance
getOrCreateInstance
Staattinen menetelmä, jonka avulla voit saada DOM-elementtiin liitetyn toast-esiintymän tai luoda uuden, jos sitä ei alustettu
var myToastEl = document.getElementById('myToastEl')
var myToast = bootstrap.Toast.getOrCreateInstance(myToastEl) // Returns a Bootstrap toast instance
Tapahtumat
Tapahtumatyyppi | Kuvaus |
---|---|
show.bs.toast |
Tämä tapahtuma käynnistyy välittömästi, kun show instanssimenetelmää kutsutaan. |
shown.bs.toast |
Tämä tapahtuma käynnistyy, kun paahtoleipä on tehty näkyväksi käyttäjälle. |
hide.bs.toast |
Tämä tapahtuma käynnistyy välittömästi, kun hide instanssimenetelmää on kutsuttu. |
hidden.bs.toast |
Tämä tapahtuma käynnistyy, kun paahtoleipä on piilotettu käyttäjältä. |
var myToastEl = document.getElementById('myToast')
myToastEl.addEventListener('hidden.bs.toast', function () {
// do something...
})