Ahenda
Muutke oma projekti sisu nähtavust mõne klassi ja meie JavaScripti pistikprogrammidega.
Kuidas see töötab
Sisu kuvamiseks ja peitmiseks kasutatakse JavaScripti ahendamise pistikprogrammi. Nuppe või ankruid kasutatakse päästikutena, mis on vastendatud konkreetsete elementidega, mida lülitate. Elemendi ahendamine animeerib height
selle praegusest väärtusest väärtusele 0
. Arvestades, kuidas CSS animatsioone käsitleb, ei saa te padding
elemendil .collapse
kasutada. Selle asemel kasutage klassi iseseisva mähiselemendina.
prefers-reduced-motion
meediumipäringust. Vaadake
meie juurdepääsetavuse dokumentatsiooni vähendatud liikumise jaotist .
Näide
Klassimuudatuste kaudu mõne muu elemendi kuvamiseks ja peitmiseks klõpsake allolevatel nuppudel:
.collapse
peidab sisu.collapsing
rakendatakse üleminekute ajal.collapse.show
näitab sisu
Üldiselt soovitame kasutada data-bs-target
atribuudiga nuppu. Ehkki see pole semantilises mõttes soovitatav, võite kasutada ka linki href
atribuudiga (ja role="button"
). Mõlemal juhul data-bs-toggle="collapse"
on nõutav.
<p>
<a class="btn btn-primary" data-bs-toggle="collapse" href="#collapseExample" role="button" aria-expanded="false" aria-controls="collapseExample">
Link with href
</a>
<button class="btn btn-primary" type="button" data-bs-toggle="collapse" data-bs-target="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
Button with data-bs-target
</button>
</p>
<div class="collapse" id="collapseExample">
<div class="card card-body">
Some placeholder content for the collapse component. This panel is hidden by default but revealed when the user activates the relevant trigger.
</div>
</div>
Mitu sihtmärki
A <button>
või <a>
saab kuvada ja peita mitut elementi, viidates neile selle href
või data-bs-target
atribuudis oleva valijaga. Mitu elementi <button>
või <a>
saab kuvada ja peita, kui igaüks viitab sellele oma href
või data-bs-target
atribuudiga
<p>
<a class="btn btn-primary" data-bs-toggle="collapse" href="#multiCollapseExample1" role="button" aria-expanded="false" aria-controls="multiCollapseExample1">Toggle first element</a>
<button class="btn btn-primary" type="button" data-bs-toggle="collapse" data-bs-target="#multiCollapseExample2" aria-expanded="false" aria-controls="multiCollapseExample2">Toggle second element</button>
<button class="btn btn-primary" type="button" data-bs-toggle="collapse" data-bs-target=".multi-collapse" aria-expanded="false" aria-controls="multiCollapseExample1 multiCollapseExample2">Toggle both elements</button>
</p>
<div class="row">
<div class="col">
<div class="collapse multi-collapse" id="multiCollapseExample1">
<div class="card card-body">
Some placeholder content for the first collapse component of this multi-collapse example. This panel is hidden by default but revealed when the user activates the relevant trigger.
</div>
</div>
</div>
<div class="col">
<div class="collapse multi-collapse" id="multiCollapseExample2">
<div class="card card-body">
Some placeholder content for the second collapse component of this multi-collapse example. This panel is hidden by default but revealed when the user activates the relevant trigger.
</div>
</div>
</div>
</div>
Juurdepääsetavus
Lisage kindlasti aria-expanded
juhtelement. See atribuut annab selgesõnaliselt edasi ekraanilugejatele ja sarnastele abitehnoloogiatele juhtelemendiga seotud kokkupandava elemendi hetkeoleku. Kui ahendav element on vaikimisi suletud, peaks juhtelemendi atribuudi väärtus olema aria-expanded="false"
. Kui olete määranud show
klassi kasutades kokkupandava elemendi vaikimisi avatuks, määrake aria-expanded="true"
selle asemel juhtelement. Pistikprogramm lülitab selle atribuudi juhtelemendil automaatselt ümber, olenevalt sellest, kas ahendatav element on avatud või suletud (JavaScripti kaudu või seetõttu, et kasutaja käivitas teise juhtelemendi, mis on samuti seotud sama ahendatava elemendiga). Kui juhtelemendi HTML-element ei ole nupp (nt <a>
või <div>
), siis atribuutrole="button"
tuleks elemendile lisada.
Kui teie juhtelement sihib ühte ahendatavat elementi – st data-bs-target
atribuut osutab id
valijale –, peaksite lisama aria-controls
atribuudi juhtelemendile, mis sisaldab id
ahendatavat elementi. Kaasaegsed ekraanilugejad ja sarnased abitehnoloogiad kasutavad seda atribuuti, et pakkuda kasutajatele täiendavaid otseteid, et navigeerida otse kokkupandava elemendi juurde.
Pange tähele, et Bootstrapi praegune juurutus ei hõlma erinevaid valikulisi klaviatuuri interaktsioone, mida on kirjeldatud WAI-ARIA Authoring Practices 1.1 akordionimustris – peate need ise kohandatud JavaScriptiga kaasama.
Sass
Muutujad
$transition-collapse: height .35s ease;
klassid
Ülemineku ahendamise klasse võib leida, scss/_transitions.scss
kuna need on jagatud mitme komponendi vahel (kokkuvarisemine ja akordion).
.collapse {
&:not(.show) {
display: none;
}
}
.collapsing {
height: 0;
overflow: hidden;
@include transition($transition-collapse);
}
Kasutamine
Ahendamise pistikprogramm kasutab raskuste tõstmiseks mõnda klassi:
.collapse
peidab sisu.collapse.show
näitab sisu.collapsing
lisatakse ülemineku alguses ja eemaldatakse, kui see lõpeb
Need klassid on leitavad _transitions.scss
.
Andmeatribuutide kaudu
Lihtsalt lisage elemendile data-bs-toggle="collapse"
ja a data-bs-target
, et määrata automaatselt juhtimine ühe või mitme kokkupandava elemendi üle. Atribuut data-bs-target
aktsepteerib ahendamise rakendamiseks CSS-i valijat. Kindlasti lisage klass collapse
kokkupandavale elemendile. Kui soovite, et see oleks vaikimisi avatud, lisage täiendav klass show
.
Akordionilaadse rühmahalduse lisamiseks kokkupandavale alale lisage andmete atribuutdata-bs-parent="#selector"
. Selle tegevuse nägemiseks vaadake demo.
JavaScripti kaudu
Luba käsitsi:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
Valikud
Valikud saab edastada andmeatribuutide või JavaScripti kaudu. Andmeatribuutide jaoks lisage valiku nimi data-bs-
, nagu data-bs-parent=""
.
Nimi | Tüüp | Vaikimisi | Kirjeldus |
---|---|---|---|
parent |
valija | jQuery objekt | DOM element | false |
Kui on ette nähtud ülem, suletakse selle ahendatava üksuse kuvamisel kõik määratud vanema all olevad kokkupandavad elemendid. (sarnane traditsioonilise akordioni käitumisega – see oleneb card klassist). Atribuut tuleb määrata kokkupandaval sihtpiirkonnal. |
toggle |
tõeväärtus | true |
Lülitab kutsumisel kokkupandava elemendi sisse |
meetodid
Asünkroonsed meetodid ja üleminekud
Kõik API meetodid on asünkroonsed ja alustavad üleminekut . Nad naasevad helistaja juurde kohe pärast ülemineku algust, kuid enne selle lõppu . Lisaks ignoreeritakse üleminekukomponendi meetodikutset .
Lisateabe saamiseks vaadake meie JavaScripti dokumentatsiooni .
Aktiveerib teie sisu kokkupandava elemendina. Aktsepteerib valikulisi valikuid object
.
Konstruktoriga saate luua ahendamise eksemplari, näiteks:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
meetod | Kirjeldus |
---|---|
toggle |
Lülitab kokkupandava elemendi kuvatud või peidetud olekuks. Naaseb helistaja juurde enne, kui kokkupandav element on tegelikult näidatud või peidetud (st enne sündmuse shown.bs.collapse või hidden.bs.collapse toimumist). |
show |
Näitab kokkupandavat elementi. Naaseb helistaja juurde enne, kui kokkupandavat elementi on tegelikult näidatud (nt enne shown.bs.collapse sündmuse toimumist). |
hide |
Peidab kokkupandava elemendi. Naaseb helistaja juurde enne, kui kokkupandav element on tegelikult peidetud (nt enne hidden.bs.collapse sündmuse toimumist). |
dispose |
Hävitab elemendi kokkuvarisemise. (Eemaldab DOM-elemendile salvestatud andmed) |
getInstance |
Staatiline meetod, mis võimaldab teil saada DOM-i elemendiga seotud ahendamise eksemplari, saate seda kasutada järgmiselt:bootstrap.Collapse.getInstance(element) |
getOrCreateInstance |
Staatiline meetod, mis tagastab DOM-i elemendiga seotud ahendamise eksemplari või loob uue juhul, kui seda ei lähtestatud. Saate seda kasutada järgmiselt:bootstrap.Collapse.getOrCreateInstance(element) |
Sündmused
Bootstrapi ahendamisklass paljastab mõned sündmused, mis on seotud ahendamise funktsiooniga.
Sündmuse tüüp | Kirjeldus |
---|---|
show.bs.collapse |
See sündmus käivitub kohe, kui show eksemplari meetod kutsutakse. |
shown.bs.collapse |
See sündmus käivitatakse, kui ahendamise element on kasutajale nähtavaks tehtud (ootab, kuni CSS-i üleminekud on lõpule viidud). |
hide.bs.collapse |
See sündmus käivitatakse kohe, kui hide meetod on välja kutsutud. |
hidden.bs.collapse |
See sündmus käivitatakse, kui ahendamise element on kasutaja eest peidetud (ootab, kuni CSS-i üleminekud on lõpule viidud). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})