Colaps
Comutați vizibilitatea conținutului în cadrul proiectului dvs. cu câteva clase și pluginurile noastre JavaScript.
Cum functioneaza
Pluginul JavaScript restrâns este folosit pentru a afișa și a ascunde conținutul. Butoanele sau ancorele sunt folosite ca declanșatori care sunt mapate la anumite elemente pe care le comutați. Restrângerea unui element va anima de height
la valoarea sa curentă la 0
. Având în vedere modul în care CSS gestionează animațiile, nu puteți utiliza padding
pe un .collapse
element. În schimb, utilizați clasa ca element independent de împachetare.
prefers-reduced-motion
interogarea media. Consultați
secțiunea cu mișcare redusă a documentației noastre de accesibilitate .
Exemplu
Faceți clic pe butoanele de mai jos pentru a afișa și a ascunde un alt element prin modificări de clasă:
.collapse
ascunde conținutul.collapsing
se aplică în timpul tranzițiilor.collapse.show
afișează conținut
În general, vă recomandăm să folosiți un buton cu data-bs-target
atributul. Deși nu este recomandat din punct de vedere semantic, puteți utiliza și o legătură cu href
atributul (și un role="button"
). În ambele cazuri, data-bs-toggle="collapse"
este necesar.
<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>
Orizontală
Pluginul de restrângere acceptă și restrângerea orizontală. Adăugați .collapse-horizontal
clasa modificatoare pentru a face tranziția în width
loc de height
și setați a width
pe elementul secundar imediat. Simțiți-vă liber să scrieți propriul dvs. Sass personalizat, să folosiți stiluri inline sau să folosiți utilitatile noastre de lățime .
min-height
set pentru a evita repetarea excesivă în documentele noastre, acest lucru nu este necesar în mod explicit.
Este necesar doar elementul de width
pe copil.
<p>
<button class="btn btn-primary" type="button" data-bs-toggle="collapse" data-bs-target="#collapseWidthExample" aria-expanded="false" aria-controls="collapseWidthExample">
Toggle width collapse
</button>
</p>
<div style="min-height: 120px;">
<div class="collapse collapse-horizontal" id="collapseWidthExample">
<div class="card card-body" style="width: 300px;">
This is some placeholder content for a horizontal collapse. It's hidden by default and shown when triggered.
</div>
</div>
</div>
Ținte multiple
A <button>
sau <a>
poate afișa și ascunde mai multe elemente, referindu-le cu un selector în atributul href
sau . data-bs-target
Multiple <button>
sau <a>
pot afișa și ascunde un element dacă fiecare face referire la el cu atributul href
saudata-bs-target
<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>
Accesibilitate
Asigurați-vă că adăugați aria-expanded
la elementul de control. Acest atribut transmite în mod explicit starea curentă a elementului pliabil legat de control către cititoarele de ecran și tehnologiile de asistență similare. Dacă elementul pliabil este închis implicit, atributul de pe elementul de control ar trebui să aibă valoarea aria-expanded="false"
. Dacă ați setat elementul pliabil să fie deschis în mod implicit folosind show
clasa, setați aria-expanded="true"
în schimb controlul. Pluginul va comuta automat acest atribut pe control în funcție de faptul dacă elementul pliabil a fost deschis sau închis sau nu (prin JavaScript sau pentru că utilizatorul a declanșat un alt element de control legat de același element pliabil). Dacă elementul HTML al elementului de control nu este un buton (de exemplu, un <a>
sau <div>
), atributulrole="button"
ar trebui adăugat la element.
Dacă elementul dvs. de control vizează un singur element pliabil - adică data-bs-target
atributul indică către un id
selector - ar trebui să adăugați aria-controls
atributul la elementul de control, care conține id
elementul pliabil. Cititoarele de ecran moderne și tehnologiile de asistență similare folosesc acest atribut pentru a oferi utilizatorilor comenzi rapide suplimentare pentru a naviga direct la elementul pliabil în sine.
Rețineți că implementarea actuală a Bootstrap nu acoperă diferitele interacțiuni opționale de la tastatură descrise în modelul de acordeon WAI-ARIA Authoring Practices 1.1 - va trebui să le includeți singur cu JavaScript personalizat.
Sass
Variabile
$transition-collapse: height .35s ease;
$transition-collapse-width: width .35s ease;
Clase
Clasele de tranziție colaps pot fi găsite în scss/_transitions.scss
, deoarece acestea sunt partajate între mai multe componente (restrângere și acordeon).
.collapse {
&:not(.show) {
display: none;
}
}
.collapsing {
height: 0;
overflow: hidden;
@include transition($transition-collapse);
&.collapse-horizontal {
width: 0;
height: auto;
@include transition($transition-collapse-width);
}
}
Utilizare
Pluginul de colaps folosește câteva clase pentru a face față sarcinilor grele:
.collapse
ascunde conținutul.collapse.show
arata continutul.collapsing
este adăugată când începe tranziția și eliminată când se termină
Aceste clase pot fi găsite în _transitions.scss
.
Prin atribute de date
Doar adăugați data-bs-toggle="collapse"
și data-bs-target
a elementului pentru a atribui automat controlul unuia sau mai multor elemente pliabile. Atributul data-bs-target
acceptă un selector CSS pentru a aplica restrângerea. Asigurați-vă că adăugați clasa collapse
la elementul pliabil. Dacă doriți să se deschidă implicit, adăugați clasa suplimentară show
.
Pentru a adăuga un management de grup asemănător unui acordeon într-o zonă pliabilă, adăugați atributul de date data-bs-parent="#selector"
. Consultați pagina acordeonului pentru mai multe informații.
Prin JavaScript
Activați manual cu:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
Opțiuni
Opțiunile pot fi transmise prin atribute de date sau JavaScript. Pentru atributele datelor, adăugați numele opțiunii la data-bs-
, ca în data-bs-parent=""
.
Nume | Tip | Mod implicit | Descriere |
---|---|---|---|
parent |
selector | obiect jQuery | element DOM | false |
Dacă este furnizat elementul părinte, atunci toate elementele pliabile de sub părintele specificat vor fi închise atunci când este afișat acest element pliabil. (similar cu comportamentul tradițional la acordeon - acesta depinde de card clasă). Atributul trebuie setat pe zona țintă pliabilă. |
toggle |
boolean | true |
Comută elementul pliabil la invocare |
Metode
Metode și tranziții asincrone
Toate metodele API sunt asincrone și încep o tranziție . Ei revin la apelant imediat ce tranziția este începută, dar înainte ca aceasta să se încheie . În plus, un apel de metodă pentru o componentă de tranziție va fi ignorat .
Consultați documentația noastră JavaScript pentru mai multe informații .
Activează conținutul dvs. ca element pliabil. Acceptă opțiuni opționale object
.
Puteți crea o instanță de colaps cu constructorul, de exemplu:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
Metodă | Descriere |
---|---|
toggle |
Comută un element pliabil la afișat sau ascuns. Se întoarce la apelant înainte ca elementul pliabil să fi fost efectiv afișat sau ascuns (adică înainte ca evenimentul shown.bs.collapse sau să hidden.bs.collapse apară). |
show |
Afișează un element pliabil. Se întoarce la apelant înainte ca elementul pliabil să fie afișat efectiv (de exemplu, înainte de apariția shown.bs.collapse evenimentului). |
hide |
Ascunde un element pliabil. Se întoarce la apelant înainte ca elementul pliabil să fi fost efectiv ascuns (de exemplu, înainte ca hidden.bs.collapse evenimentul să apară). |
dispose |
Distruge prăbușirea unui element. (Elimină datele stocate pe elementul DOM) |
getInstance |
Metodă statică care vă permite să obțineți instanța de colaps asociată unui element DOM, o puteți utiliza astfel:bootstrap.Collapse.getInstance(element) |
getOrCreateInstance |
Metodă statică care returnează o instanță de colaps asociată unui element DOM sau creează una nouă în cazul în care nu a fost inițializată. Îl poți folosi astfel:bootstrap.Collapse.getOrCreateInstance(element) |
Evenimente
Clasa de colaps a lui Bootstrap expune câteva evenimente pentru conectarea la funcționalitatea de colaps.
Tip de eveniment | Descriere |
---|---|
show.bs.collapse |
Acest eveniment se declanșează imediat când show este apelată metoda instanței. |
shown.bs.collapse |
Acest eveniment este declanșat atunci când un element de restrângere a fost făcut vizibil pentru utilizator (va aștepta finalizarea tranzițiilor CSS). |
hide.bs.collapse |
Acest eveniment este declanșat imediat când hide metoda a fost apelată. |
hidden.bs.collapse |
Acest eveniment este declanșat atunci când un element de restrângere a fost ascuns utilizatorului (va aștepta finalizarea tranzițiilor CSS). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})