Згорнути
Перемкніть видимість вмісту у вашому проекті за допомогою кількох класів і наших плагінів JavaScript.
Як це працює
Плагін JavaScript для згортання використовується для показу та приховання вмісту. Кнопки або прив’язки використовуються як тригери, які зіставляються з певними елементами, які ви перемикаєте. Згортання елемента анімує height
його поточне значення до 0
. Зважаючи на те, як CSS обробляє анімацію, ви не можете використовувати padding
для .collapse
елемента. Замість цього використовуйте клас як незалежний елемент обгортки.
prefers-reduced-motion
медіа-запиту. Перегляньте розділ про
обмежений рух нашої документації щодо спеціальних можливостей .
приклад
Натисніть кнопки нижче, щоб показати або приховати інший елемент за допомогою змін класу:
.collapse
приховує вміст.collapsing
застосовується під час переходів.collapse.show
показує вміст
Зазвичай ми рекомендуємо використовувати кнопку з data-bs-target
атрибутом. Хоча це не рекомендується із семантичної точки зору, ви також можете використовувати посилання з href
атрибутом (і role="button"
). В обох випадках data-bs-toggle="collapse"
потрібно.
<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>
Горизонтальний
Плагін згортання також підтримує горизонтальне згортання. Додайте .collapse-horizontal
клас-модифікатор для переходу width
замість height
і встановіть для width
безпосереднього дочірнього елемента. Не соромтеся писати свій власний Sass, використовувати вбудовані стилі або наші утиліти ширини .
min-height
набір для уникнення надмірного перефарбовування в наших документах, це явно не вимагається.
Потрібен лише width
дочірній елемент.
<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>
Кілька цілей
А <button>
або <a>
може показувати та приховувати кілька елементів, посилаючись на них за допомогою селектора в атрибуті href
або . data-bs-target
Кілька <button>
або <a>
можуть показувати та приховувати елемент, якщо кожен з них посилається на нього за допомогою свого атрибута href
абоdata-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>
Доступність
Обов'язково додайте aria-expanded
до елемента управління. Цей атрибут явно передає поточний стан елемента, що згортається, пов’язаного з елементом керування програмами зчитування з екрана та подібними допоміжними технологіями. Якщо елемент, що згортається, закрито за замовчуванням, атрибут елемента керування має мати значення aria-expanded="false"
. Якщо ви встановили, що елемент, що згортається, відкритий за замовчуванням за допомогою show
класу, aria-expanded="true"
замість цього встановіть елемент керування. Плагін автоматично перемикає цей атрибут на елементі керування залежно від того, чи був відкритий чи закритий елемент, що згортається, чи ні (через JavaScript або через те, що користувач запустив інший елемент керування, також прив’язаний до того самого елемента, що згортається). Якщо елемент HTML елемента керування не є кнопкою (наприклад, <a>
або <div>
), атрибутrole="button"
слід додати до елемента.
Якщо ваш елемент керування націлений на один елемент, що згортається, тобто data-bs-target
атрибут вказує на id
селектор, вам слід додати aria-controls
атрибут до елемента керування, який містить елемент, що id
згортається. Сучасні програми зчитування з екрана та подібні допоміжні технології використовують цей атрибут, щоб надати користувачам додаткові ярлики для переходу безпосередньо до самого елемента, що згортається.
Зауважте, що поточна реалізація Bootstrap не охоплює різні додаткові взаємодії з клавіатурою, описані в акордеонному шаблоні WAI-ARIA Authoring Practices 1.1 - вам потрібно буде включити їх самостійно за допомогою спеціального JavaScript.
Сасс
Змінні
$transition-collapse: height .35s ease;
$transition-collapse-width: width .35s ease;
Заняття
Класи переходу згортання можна знайти в scss/_transitions.scss
, оскільки вони спільні для кількох компонентів (згортання та акордеон).
.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);
}
}
Використання
Плагін згортання використовує кілька класів для обробки важких завдань:
.collapse
приховує вміст.collapse.show
показує вміст.collapsing
додається, коли перехід починається, і видаляється, коли він завершується
Ці класи можна знайти в _transitions.scss
.
Через атрибути даних
Просто додайте data-bs-toggle="collapse"
та data-bs-target
до елемента, щоб автоматично призначити керування одним або декількома складними елементами. Атрибут data-bs-target
приймає селектор CSS для застосування згортання. Обов’язково додайте клас collapse
до розбірного елемента. Якщо ви хочете, щоб він відкривався за умовчанням, додайте додатковий клас show
.
Щоб додати до згорнутої області керування групами, схоже на акордеон, додайте атрибут даних data-bs-parent="#selector"
. Для отримання додаткової інформації зверніться до сторінки акордеон .
Через JavaScript
Увімкнути вручну за допомогою:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
Опції
Параметри можна передати через атрибути даних або JavaScript. Для атрибутів даних додайте назву опції до data-bs-
, як у data-bs-parent=""
.
Ім'я | Тип | За замовчуванням | опис |
---|---|---|---|
parent |
селектор | Об'єкт jQuery | Елемент DOM | false |
Якщо вказано батьківський елемент, усі елементи, що згортаються, у вказаному батьківському елементі будуть закриті, коли буде показано цей згорнутий елемент. (подібна до традиційної поведінки акордеона - це залежить від card класу). Атрибут має бути встановлено на цільовій складній області. |
toggle |
логічний | true |
Перемикає елемент, що згортається, під час виклику |
методи
Асинхронні методи та переходи
Усі методи API є асинхронними та починають перехід . Вони повертаються до абонента, щойно перехід починається, але до його завершення . Крім того, виклик методу компонента, що переходить, ігноруватиметься .
Дивіться нашу документацію JavaScript для отримання додаткової інформації .
Активує ваш вміст як складний елемент. Приймає додаткові параметри object
.
Ви можете створити екземпляр згортання за допомогою конструктора, наприклад:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
метод | опис |
---|---|
toggle |
Перемикає елемент, що згортається, на показаний або прихований. Повертається до абонента до того, як згорнутий елемент буде фактично показано або приховано (тобто до того, як відбудеться подія shown.bs.collapse або ).hidden.bs.collapse |
show |
Показує розбірний елемент. Повертається до абонента до того, як згорнутий елемент буде фактично показано (наприклад, до shown.bs.collapse події). |
hide |
Приховує розбірний елемент. Повертається до абонента до того, як згорнутий елемент буде фактично приховано (наприклад, до того, як відбудеться hidden.bs.collapse подія). |
dispose |
Руйнує колапс елемента. (Видаляє збережені дані в елементі DOM) |
getInstance |
Статичний метод, який дозволяє вам отримати екземпляр згортання, пов’язаний з елементом DOM, ви можете використовувати його так:bootstrap.Collapse.getInstance(element) |
getOrCreateInstance |
Статичний метод, який повертає екземпляр згортання, пов’язаний з елементом DOM, або створює новий, якщо він не був ініціалізований. Ви можете використовувати це так:bootstrap.Collapse.getOrCreateInstance(element) |
Події
Клас згортання Bootstrap надає кілька подій для підключення до функціональності згортання.
Тип події | опис |
---|---|
show.bs.collapse |
Ця подія запускається негайно, коли show викликається метод екземпляра. |
shown.bs.collapse |
Ця подія запускається, коли елемент згортання стає видимим для користувача (чекатиме, поки завершаться переходи CSS). |
hide.bs.collapse |
Ця подія запускається відразу після виклику hide методу. |
hidden.bs.collapse |
Ця подія запускається, коли елемент згортання приховано від користувача (чекатиме, поки завершаться переходи CSS). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})