Upadek
Przełącz widoczność treści w całym projekcie za pomocą kilku klas i naszych wtyczek JavaScript.
Jak to działa
Wtyczka scalania JavaScript służy do pokazywania i ukrywania treści. Przyciski lub kotwice są używane jako wyzwalacze, które są mapowane na określone elementy, które przełączasz. Zwinięcie elementu spowoduje animację height
z jego bieżącej wartości do 0
. Biorąc pod uwagę, jak CSS obsługuje animacje, nie możesz użyć padding
na .collapse
elemencie. Zamiast tego użyj klasy jako niezależnego elementu opakowującego.
prefers-reduced-motion
zapytania o media. Zobacz
zmniejszoną sekcję ruchu w naszej dokumentacji ułatwień dostępu .
Przykład
Kliknij poniższe przyciski, aby pokazać i ukryć inny element poprzez zmiany klasy:
.collapse
ukrywa treść.collapsing
jest stosowany podczas przejść.collapse.show
pokazuje treść
Generalnie zalecamy używanie przycisku z data-bs-target
atrybutem. Chociaż nie jest to zalecane z semantycznego punktu widzenia, możesz również użyć linku z href
atrybutem (i role="button"
). W obu przypadkach data-bs-toggle="collapse"
jest to wymagane.
<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>
Poziomy
Wtyczka zwijania obsługuje również zwijanie w poziomie. Dodaj .collapse-horizontal
klasę modyfikatora do przejścia width
zamiast height
i ustaw a width
na bezpośrednim elemencie podrzędnym. Zachęcamy do napisania własnego niestandardowego Sassa, używania stylów wbudowanych lub korzystania z naszych narzędzi szerokości .
min-height
zestaw, aby uniknąć nadmiernego odświeżania w naszych dokumentach, nie jest to wyraźnie wymagane.
Wymagany jest tylko width
element podrzędny.
<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>
Wiele celów
A <button>
lub <a>
może pokazywać i ukrywać wiele elementów, odwołując się do nich za pomocą selektora w jego atrybucie href
lub . data-bs-target
Wiele <button>
lub <a>
może pokazywać i ukrywać element, jeśli każdy z nich odwołuje się do niego za pomocą swojego atrybutu href
lubdata-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>
Dostępność
Pamiętaj, aby dodać aria-expanded
do elementu kontrolnego. Ten atrybut jawnie przekazuje bieżący stan zwijanego elementu powiązanego z kontrolką z czytnikami ekranu i podobnymi technologiami pomocniczymi. Jeśli zwijany element jest domyślnie zamknięty, atrybut elementu sterującego powinien mieć wartość aria-expanded="false"
. Jeśli ustawisz zwijany element, aby był domyślnie otwarty przy użyciu show
klasy, aria-expanded="true"
zamiast tego ustaw kontrolkę. Wtyczka automatycznie przełączy ten atrybut w kontrolce na podstawie tego, czy zwijalny element został otwarty lub zamknięty (za pomocą JavaScript lub dlatego, że użytkownik wyzwolił inny element sterujący również powiązany z tym samym zwijanym elementem). Jeśli element HTML elementu kontrolnego nie jest przyciskiem (np. an <a>
lub <div>
), atrybutrole="button"
należy dodać do elementu.
Jeśli Twój element kontrolny jest skierowany na pojedynczy zwijalny element – tj. data-bs-target
atrybut wskazuje na id
selektor – powinieneś dodać aria-controls
atrybut do elementu kontrolnego zawierającego id
element zwijalny. Nowoczesne czytniki ekranu i podobne technologie wspomagające wykorzystują ten atrybut, aby zapewnić użytkownikom dodatkowe skróty umożliwiające nawigację bezpośrednio do samego zwijanego elementu.
Zwróć uwagę, że obecna implementacja Bootstrapa nie obejmuje różnych opcjonalnych interakcji klawiatury opisanych we wzorcu akordeonowym WAI-ARIA Authoring Practices 1.1 — musisz je dołączyć samodzielnie w niestandardowym JavaScript.
Sass
Zmienne
$transition-collapse: height .35s ease;
$transition-collapse-width: width .35s ease;
Klasy
Klasy przejść można znaleźć w Collapse, scss/_transitions.scss
ponieważ są one współdzielone przez wiele komponentów (collapse i akordeon).
.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);
}
}
Stosowanie
Wtyczka zwijania wykorzystuje kilka klas do obsługi podnoszenia ciężkich przedmiotów:
.collapse
ukrywa treść.collapse.show
pokazuje treść.collapsing
jest dodawany po rozpoczęciu przejścia i usuwany po jego zakończeniu
Te klasy można znaleźć w _transitions.scss
.
Poprzez atrybuty danych
Wystarczy dodać data-bs-toggle="collapse"
i a data-bs-target
do elementu, aby automatycznie przypisać kontrolę nad jednym lub większą liczbą zwijanych elementów. data-bs-target
Atrybut akceptuje selektor CSS, do którego ma zostać zastosowane zwinięcie . Pamiętaj, aby dodać klasę collapse
do zwijanego elementu. Jeśli chcesz, aby była domyślnie otwarta, dodaj dodatkowe zajęcia show
.
Aby dodać zarządzanie grupami w stylu harmonijki do zwijanego obszaru, dodaj atrybut data data-bs-parent="#selector"
. Więcej informacji znajdziesz na stronie akordeonu .
Przez JavaScript
Włącz ręcznie za pomocą:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
Opcje
Opcje można przekazywać za pomocą atrybutów danych lub JavaScript. W przypadku atrybutów danych dołącz nazwę opcji do data-bs-
, jak w data-bs-parent=""
.
Nazwa | Rodzaj | Domyślna | Opis |
---|---|---|---|
parent |
selektor | jQuery obiekt | element DOM | false |
Jeśli podano element nadrzędny, wszystkie zwijalne elementy pod określonym elementem nadrzędnym zostaną zamknięte, gdy ten zwijalny element zostanie wyświetlony. (podobne do tradycyjnego zachowania akordeonowego - zależy to od card klasy). Atrybut musi być ustawiony na docelowym zwijanym obszarze. |
toggle |
logiczne | true |
Przełącza zwijany element przy wywołaniu |
Metody
Metody asynchroniczne i przejścia
Wszystkie metody API są asynchroniczne i rozpoczynają przejście . Wracają do rozmówcy zaraz po rozpoczęciu przejścia, ale przed jego zakończeniem . Ponadto wywołanie metody na składniku przechodzącym zostanie zignorowane .
Zobacz naszą dokumentację JavaScript, aby uzyskać więcej informacji .
Aktywuje zawartość jako zwijany element. Akceptuje opcjonalne opcje object
.
Możesz utworzyć instancję zwinięcia za pomocą konstruktora, na przykład:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
metoda | Opis |
---|---|
toggle |
Przełącza zwijany element na pokazany lub ukryty. Wraca do wywołującego, zanim zwijany element został faktycznie pokazany lub ukryty (tj. przed wystąpieniem zdarzenia shown.bs.collapse lub ).hidden.bs.collapse |
show |
Pokazuje składany element. Powraca do wywołującego, zanim zwijany element został faktycznie pokazany (np. przed shown.bs.collapse wystąpieniem zdarzenia). |
hide |
Ukrywa składany element. Wraca do wywołującego, zanim zwijalny element został faktycznie ukryty (np. przed hidden.bs.collapse wystąpieniem zdarzenia). |
dispose |
Niszczy upadek elementu. (Usuwa dane zapisane w elemencie DOM) |
getInstance |
Metoda statyczna, która pozwala uzyskać instancję zwinięcia skojarzoną z elementem DOM, możesz jej użyć w następujący sposób:bootstrap.Collapse.getInstance(element) |
getOrCreateInstance |
Metoda statyczna, która zwraca instancję zwijania skojarzoną z elementem DOM lub tworzy nową w przypadku, gdy nie została zainicjowana. Możesz go użyć w ten sposób:bootstrap.Collapse.getOrCreateInstance(element) |
Wydarzenia
Klasa zwijania Bootstrap udostępnia kilka zdarzeń umożliwiających podłączenie do funkcji zwijania.
Typ wydarzenia | Opis |
---|---|
show.bs.collapse |
To zdarzenie jest wyzwalane natychmiast po show wywołaniu metody wystąpienia. |
shown.bs.collapse |
To zdarzenie jest wywoływane, gdy element zwinięcia jest widoczny dla użytkownika (poczeka na zakończenie przejścia CSS). |
hide.bs.collapse |
To zdarzenie jest wywoływane natychmiast po hide wywołaniu metody. |
hidden.bs.collapse |
To zdarzenie jest wywoływane, gdy element zwinięcia zostanie ukryty przed użytkownikiem (poczeka na zakończenie przejścia CSS). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})