kolaps
Prepnite viditeľnosť obsahu vo svojom projekte pomocou niekoľkých tried a našich doplnkov JavaScript.
Ako to funguje
Zásuvný modul JavaScript sa používa na zobrazenie a skrytie obsahu. Tlačidlá alebo kotvy sa používajú ako spúšťače, ktoré sú namapované na konkrétne prvky, ktoré prepínate. Zbalením prvku sa prvok animuje height
z jeho aktuálnej hodnoty na 0
. Vzhľadom na to, ako CSS spracováva animácie, nemôžete použiť padding
na .collapse
prvok. Namiesto toho použite triedu ako nezávislý obalový prvok.
prefers-reduced-motion
mediálneho dopytu. Pozrite si
časť so zníženým pohybom v našej dokumentácii o prístupnosti .
Príklad
Kliknutím na tlačidlá nižšie zobrazíte a skryjete ďalší prvok prostredníctvom zmien triedy:
.collapse
skrýva obsah.collapsing
sa aplikuje pri prechodoch.collapse.show
zobrazuje obsah
Vo všeobecnosti odporúčame použiť tlačidlo s data-bs-target
atribútom. Aj keď sa to zo sémantického hľadiska neodporúča, môžete použiť aj prepojenie s href
atribútom (a role="button"
). V oboch prípadoch data-bs-toggle="collapse"
sa vyžaduje.
<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>
Viaceré ciele
A <button>
alebo <a>
môže zobraziť a skryť viacero prvkov tak, že na ne odkazuje selektorom vo svojom atribúte href
alebo . data-bs-target
Viacnásobné <button>
alebo <a>
môžu zobraziť a skryť prvok, ak naň každý odkazuje svojím atribútom href
alebo data-bs-target
atribútom
<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>
Prístupnosť
Nezabudnite pridať aria-expanded
do ovládacieho prvku. Tento atribút explicitne vyjadruje aktuálny stav skladacieho prvku spojeného s ovládacím prvkom čítačkám obrazovky a podobným asistenčným technológiám. Ak je skladací prvok predvolene zatvorený, atribút ovládacieho prvku by mal mať hodnotu aria-expanded="false"
. Ak ste nastavili, aby bol skladací prvok predvolene otvorený pomocou show
triedy, nastavte aria-expanded="true"
ho na ovládacom prvku. Doplnok automaticky prepne tento atribút na ovládacom prvku na základe toho, či bol alebo nebol skladací prvok otvorený alebo zatvorený (cez JavaScript, alebo pretože používateľ spustil iný ovládací prvok, ktorý je tiež viazaný na rovnaký skladací prvok). Ak prvkom HTML ovládacieho prvku nie je tlačidlo (napr. <a>
alebo <div>
), atribútrole="button"
treba pridať k prvku.
Ak je váš ovládací prvok zacielený na jeden skladací prvok – tj data-bs-target
atribút ukazuje na id
selektor – mali by ste pridať aria-controls
atribút do ovládacieho prvku, ktorý obsahuje id
skladací prvok. Moderné čítačky obrazovky a podobné asistenčné technológie využívajú tento atribút na to, aby používateľom poskytli ďalšie skratky na prechod priamo na samotný skladací prvok.
Všimnite si, že súčasná implementácia Bootstrapu nepokrýva rôzne voliteľné interakcie s klávesnicou popísané vo vzore akordeónu WAI-ARIA Authoring Practices 1.1 – budete ich musieť zahrnúť do vlastného JavaScriptu.
Sass
Premenné
$transition-collapse: height .35s ease;
triedy
Prechodové triedy kolapsu možno nájsť v scss/_transitions.scss
, pretože sú zdieľané medzi viacerými komponentmi (kolaps a akordeón).
.collapse {
&:not(.show) {
display: none;
}
}
.collapsing {
height: 0;
overflow: hidden;
@include transition($transition-collapse);
}
Použitie
Zásuvný modul používa niekoľko tried na zvládnutie ťažkého zdvíhania:
.collapse
skrýva obsah.collapse.show
zobrazuje obsah.collapsing
sa pridá pri spustení prechodu a odstráni sa po jeho dokončení
Tieto triedy nájdete v _transitions.scss
.
Cez dátové atribúty
Stačí pridať data-bs-toggle="collapse"
a data-bs-target
k prvku a automaticky priradiť ovládanie jedného alebo viacerých skladacích prvkov. Atribút data-bs-target
akceptuje selektor CSS, na ktorý sa má použiť zbalenie. Nezabudnite pridať triedu collapse
do skladacieho prvku. Ak chcete, aby bola predvolene otvorená, pridajte ďalšiu triedu show
.
Ak chcete do skladacej oblasti pridať správu skupiny podobnú akordeónu, pridajte atribút data data-bs-parent="#selector"
. Pozrite si ukážku, aby ste to videli v akcii.
Cez JavaScript
Povoliť manuálne pomocou:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
možnosti
Možnosti môžu byť odovzdané prostredníctvom dátových atribútov alebo JavaScriptu. Pre atribúty údajov pripojte názov voľby k data-bs-
, ako v data-bs-parent=""
.
názov | Typ | Predvolené | Popis |
---|---|---|---|
parent |
volič | objekt jQuery | prvok DOM | false |
Ak je zadaný rodič, potom sa všetky skladacie prvky pod zadaným nadradeným prvkom zatvoria, keď sa zobrazí táto skladacia položka. (podobné tradičnému správaniu na akordeóne - to závisí od card triedy). Atribút musí byť nastavený na cieľovú skladaciu oblasť. |
toggle |
boolovská hodnota | true |
Prepína zbaliteľný prvok pri vyvolaní |
Metódy
Asynchrónne metódy a prechody
Všetky metódy API sú asynchrónne a spúšťajú prechod . Vrátia sa k volajúcemu hneď po spustení prechodu, ale skôr, ako sa skončí . Okrem toho bude volanie metódy na prechodovom komponente ignorované .
Aktivuje váš obsah ako skladací prvok. Prijíma voliteľné možnosti object
.
Inštanciu kolapsu môžete vytvoriť pomocou konštruktora, napríklad:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
Metóda | Popis |
---|---|
toggle |
Prepne zbaliteľný prvok na zobrazený alebo skrytý. Vráti sa k volajúcemu skôr, ako sa skladací prvok skutočne zobrazí alebo skryje (tj predtým, ako nastane udalosť shown.bs.collapse alebo ).hidden.bs.collapse |
show |
Zobrazuje skladací prvok. Vráti sa k volajúcemu skôr, ako sa skladací prvok skutočne zobrazí (napr. pred shown.bs.collapse výskytom udalosti). |
hide |
Skryje skladací prvok. Vráti sa k volajúcemu skôr, ako bol skladací prvok skutočne skrytý (napr. pred hidden.bs.collapse výskytom udalosti). |
dispose |
Zničí kolaps prvku. (Odstráni uložené údaje v prvku DOM) |
getInstance |
Statická metóda, ktorá vám umožňuje získať inštanciu zbalenia priradenú k prvku DOM, môžete ju použiť takto:bootstrap.Collapse.getInstance(element) |
getOrCreateInstance |
Statická metóda, ktorá vráti inštanciu zbalenia spojenú s prvkom DOM alebo vytvorí novú v prípade, že nebola inicializovaná. Môžete ho použiť takto:bootstrap.Collapse.getOrCreateInstance(element) |
Diania
Trieda zbalenia Bootstrapu odhaľuje niekoľko udalostí na pripojenie k funkcii zbalenia.
Typ udalosti | Popis |
---|---|
show.bs.collapse |
Táto udalosť sa spustí okamžite pri show volaní metódy inštancie. |
shown.bs.collapse |
Táto udalosť sa spustí, keď je prvok zbalenia viditeľný pre používateľa (bude čakať na dokončenie prechodov CSS). |
hide.bs.collapse |
Táto udalosť sa spustí okamžite po hide zavolaní metódy. |
hidden.bs.collapse |
Táto udalosť sa spustí, keď bol prvok zbalenia skrytý pred používateľom (bude čakať na dokončenie prechodov CSS). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})