Instorten
Verander de zichtbaarheid van inhoud in uw project met een paar klassen en onze JavaScript-plug-ins.
Hoe het werkt
De JavaScript-plug-in voor samenvouwen wordt gebruikt om inhoud te tonen en te verbergen. Knoppen of ankers worden gebruikt als triggers die zijn toegewezen aan specifieke elementen die u inschakelt. Als u een element samenvouwt, wordt het geanimeerd height
van de huidige waarde naar 0
. Gezien de manier waarop CSS met animaties omgaat, kunt u deze niet padding
op een .collapse
element gebruiken. Gebruik in plaats daarvan de klasse als een onafhankelijk verpakkingselement.
prefers-reduced-motion
mediaquery. Zie het
gedeelte over beperkte beweging van onze toegankelijkheidsdocumentatie .
Voorbeeld
Klik op de onderstaande knoppen om een ander element te tonen en te verbergen via klassewijzigingen:
.collapse
verbergt inhoud.collapsing
wordt toegepast tijdens overgangen.collapse.show
toont inhoud
Over het algemeen raden we aan om een knop met het data-bs-target
attribuut te gebruiken. Hoewel dit vanuit semantisch oogpunt niet wordt aanbevolen, kunt u ook een link gebruiken met het href
attribuut (en een role="button"
). In beide gevallen data-bs-toggle="collapse"
is het verplicht.
<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>
Horizontaal
De inklapplug-in ondersteunt ook horizontaal samenvouwen. Voeg de .collapse-horizontal
modificatieklasse toe om de over te zetten width
in plaats van height
en stel een width
in op het directe onderliggende element. Voel je vrij om je eigen aangepaste Sass te schrijven, inline-stijlen te gebruiken of onze breedtehulpprogramma's te gebruiken .
min-height
set bevat om overmatig opnieuw schilderen in onze documenten te voorkomen, dit niet expliciet vereist is.
Alleen het width
element on the child is vereist.
<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>
Meerdere doelen
Een <button>
or <a>
kan meerdere elementen tonen en verbergen door ernaar te verwijzen met een selector in zijn href
of data-bs-target
attribuut. Meerdere <button>
of <a>
kunnen een element tonen en verbergen als ze er elk naar verwijzen met hun href
of data-bs-target
attribuut
<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>
Toegankelijkheid
Zorg ervoor dat u aria-expanded
het besturingselement toevoegt. Dit kenmerk geeft expliciet de huidige status van het inklapbare element dat aan het besturingselement is gekoppeld, weer aan schermlezers en vergelijkbare ondersteunende technologieën. Als het samenvouwbare element standaard is gesloten, moet het attribuut op het besturingselement een waarde hebben van aria-expanded="false"
. Als je hebt ingesteld dat het samenvouwbare element standaard open is met de show
klasse, stel je aria-expanded="true"
in plaats daarvan in op het besturingselement. De plug-in schakelt dit attribuut automatisch in op het besturingselement op basis van het feit of het inklapbare element al dan niet is geopend of gesloten (via JavaScript, of omdat de gebruiker een ander besturingselement heeft geactiveerd dat ook aan hetzelfde inklapbare element is gekoppeld). Als het HTML-element van het besturingselement geen knop is (bijv. an <a>
of <div>
), is het attribuutrole="button"
moet worden toegevoegd aan het element.
Als uw besturingselement gericht is op een enkel opvouwbaar element – dwz het data-bs-target
attribuut verwijst naar een id
selector – moet u het aria-controls
attribuut toevoegen aan het besturingselement, dat de id
van het inklapbare element bevat. Moderne schermlezers en vergelijkbare ondersteunende technologieën maken gebruik van dit kenmerk om gebruikers extra snelkoppelingen te bieden om rechtstreeks naar het inklapbare element zelf te navigeren.
Merk op dat de huidige implementatie van Bootstrap niet de verschillende optionele toetsenbordinteracties dekt die worden beschreven in het accordeonpatroon van de ARIA Authoring Practices Guide - u zult deze zelf moeten toevoegen met aangepast JavaScript.
Sass
Variabelen
$transition-collapse: height .35s ease;
$transition-collapse-width: width .35s ease;
Klassen
Collapse-overgangsklassen zijn te vinden in scss/_transitions.scss
omdat deze worden gedeeld over meerdere componenten (collapse en accordeon).
.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);
}
}
Gebruik
De instortingsplug-in gebruikt een paar klassen om het zware werk aan te kunnen:
.collapse
verbergt de inhoud.collapse.show
toont de inhoud.collapsing
wordt toegevoegd wanneer de overgang begint en verwijderd wanneer deze is voltooid
Deze lessen zijn te vinden in _transitions.scss
.
Via gegevensattributen
Voeg gewoon data-bs-toggle="collapse"
en a toe data-bs-target
aan het element om automatisch de besturing van een of meer opvouwbare elementen toe te wijzen. Het data-bs-target
attribuut accepteert een CSS-selector om het samenvouwen op toe te passen. Zorg ervoor dat u de klasse toevoegt collapse
aan het opvouwbare element. Als u wilt dat deze standaard wordt geopend, voegt u de extra klasse toe show
.
Om accordeonachtig groepsbeheer toe te voegen aan een inklapbaar gebied, voegt u het data-attribuut toe data-bs-parent="#selector"
. Raadpleeg de accordeonpagina voor meer informatie.
Via JavaScript
Handmatig inschakelen met:
const collapseElementList = document.querySelectorAll('.collapse')
const collapseList = [...collapseElementList].map(collapseEl => new bootstrap.Collapse(collapseEl))
Opties
Omdat opties kunnen worden doorgegeven via gegevensattributen of JavaScript, kunt u een optienaam toevoegen aan data-bs-
, zoals in data-bs-animation="{value}"
. Zorg ervoor dat u het kasttype van de optienaam wijzigt van " camelCase " in " kebab-case " wanneer u de opties doorgeeft via gegevensattributen. Gebruik bijvoorbeeld in data-bs-custom-class="beautifier"
plaats van data-bs-customClass="beautifier"
.
Vanaf Bootstrap 5.2.0 ondersteunen alle componenten een experimenteel gereserveerd gegevenskenmerk data-bs-config
dat een eenvoudige componentconfiguratie als een JSON-tekenreeks kan bevatten. Wanneer een element attributen heeft data-bs-config='{"delay":0, "title":123}'
, zal data-bs-title="456"
de uiteindelijke title
waarde zijn 456
en zullen de afzonderlijke gegevensattributen de waarden overschrijven die op data-bs-config
. Bovendien kunnen bestaande gegevensattributen JSON-waarden zoals data-bs-delay='{"show":0,"hide":150}'
.
Naam | Type | Standaard | Beschrijving |
---|---|---|---|
parent |
selector, DOM-element | null |
Als bovenliggend item is opgegeven, worden alle samenvouwbare elementen onder het opgegeven bovenliggende item gesloten wanneer dit opvouwbare item wordt weergegeven. (vergelijkbaar met traditioneel accordeongedrag - dit is afhankelijk van de card klas). Het attribuut moet worden ingesteld op het inklapbare doelgebied. |
toggle |
booleaans | true |
Schakelt het samenvouwbare element in bij aanroepen. |
Methoden:
Asynchrone methoden en overgangen
Alle API-methoden zijn asynchroon en starten een transitie . Ze keren terug naar de beller zodra de overgang is gestart maar voordat deze eindigt . Bovendien wordt een methodeaanroep op een overgangscomponent genegeerd .
Activeert uw inhoud als een opvouwbaar element. Accepteert een optionele optie object
.
U kunt een samenvouwingsinstantie maken met de constructor, bijvoorbeeld:
const bsCollapse = new bootstrap.Collapse('#myCollapse', {
toggle: false
})
Methode | Beschrijving |
---|---|
dispose |
Vernietigt de ineenstorting van een element. (Verwijdert opgeslagen gegevens op het DOM-element) |
getInstance |
Statische methode waarmee u de collaps-instantie kunt koppelen aan een DOM-element, u kunt deze als volgt gebruiken: bootstrap.Collapse.getInstance(element) . |
getOrCreateInstance |
Statische methode die een samenvouwingsinstantie retourneert die is gekoppeld aan een DOM-element of een nieuwe maakt voor het geval deze niet is geïnitialiseerd. Je kunt het als volgt gebruiken: bootstrap.Collapse.getOrCreateInstance(element) . |
hide |
Verbergt een opvouwbaar element. Keert terug naar de aanroeper voordat het opvouwbare element daadwerkelijk is verborgen (bijvoorbeeld voordat de hidden.bs.collapse gebeurtenis plaatsvindt). |
show |
Toont een opvouwbaar element. Keert terug naar de beller voordat het inklapbare element daadwerkelijk is getoond (bijvoorbeeld voordat de shown.bs.collapse gebeurtenis plaatsvindt). |
toggle |
Schakelt een samenvouwbaar element om naar weergegeven of verborgen. Keert terug naar de aanroeper voordat het inklapbare element daadwerkelijk is getoond of verborgen (dwz voordat de shown.bs.collapse of hidden.bs.collapse -gebeurtenis plaatsvindt). |
Evenementen
De collapsklasse van Bootstrap onthult een paar gebeurtenissen voor het aansluiten op de ineenstortingsfunctionaliteit.
Evenementtype | Beschrijving |
---|---|
hide.bs.collapse |
Deze gebeurtenis wordt onmiddellijk geactiveerd wanneer de hide methode is aangeroepen. |
hidden.bs.collapse |
Deze gebeurtenis wordt geactiveerd wanneer een samengevouwen element voor de gebruiker is verborgen (wacht tot de CSS-overgangen zijn voltooid). |
show.bs.collapse |
Deze gebeurtenis wordt onmiddellijk geactiveerd wanneer de show instantiemethode wordt aangeroepen. |
shown.bs.collapse |
Deze gebeurtenis wordt geactiveerd wanneer een samengevouwen element zichtbaar is gemaakt voor de gebruiker (wacht tot de CSS-overgangen zijn voltooid). |
const myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', event => {
// do something...
})