Свиване
Превключете видимостта на съдържанието във вашия проект с няколко класа и нашите плъгини за 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>
Множество цели
A <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;
Класове
Класовете за свиване на прехода могат да бъдат намерени в scss/_transitions.scss
, тъй като те се споделят между множество компоненти (свиване и акордеон).
.collapse {
&:not(.show) {
display: none;
}
}
.collapsing {
height: 0;
overflow: hidden;
@include transition($transition-collapse);
}
Използване
Плъгинът за свиване използва няколко класа, за да се справи с тежкото повдигане:
.collapse
скрива съдържанието.collapse.show
показва съдържанието.collapsing
се добавя, когато преходът започне, и се премахва, когато приключи
Тези класове могат да бъдат намерени в _transitions.scss
.
Чрез атрибути на данни
Просто добавете data-bs-toggle="collapse"
и data-bs-target
към елемента, за да присвоите автоматично управление на един или повече сгъваеми елементи. Атрибутът data-bs-target
приема CSS селектор, към който да се приложи свиването. Не забравяйте да добавите класа collapse
към сгъваемия елемент. Ако искате да е отворен по подразбиране, добавете допълнителния клас show
.
За да добавите подобно на акордеон групово управление към сгъваема област, добавете атрибута data 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 методи са асинхронни и стартират преход . Те се връщат при повикващия веднага щом преходът започне, но преди да приключи . В допълнение, извикване на метод на преходен компонент ще бъде игнорирано .
Активира вашето съдържание като сгъваем елемент. Приема опции по избор 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...
})