Hoppa till huvudinnehållet Hoppa till dokumentnavigering
in English

Kollaps

Växla synligheten av innehåll i ditt projekt med några klasser och våra JavaScript-plugin.

Hur det fungerar

JavaScript-pluginet för kollaps används för att visa och dölja innehåll. Knappar eller ankare används som utlösare som mappas till specifika element som du växlar. Om du komprimerar ett element animeras det heightfrån dess nuvarande värde till 0. Med tanke på hur CSS hanterar animationer kan du inte använda paddingpå ett .collapseelement. Använd istället klassen som ett oberoende omslagselement.

Animeringseffekten av denna komponent beror på prefers-reduced-motionmediefrågan. Se avsnittet för reducerad rörelse i vår tillgänglighetsdokumentation .

Exempel

Klicka på knapparna nedan för att visa och dölja ett annat element via klassändringar:

  • .collapsedöljer innehåll
  • .collapsingtillämpas under övergångar
  • .collapse.showvisar innehåll

I allmänhet rekommenderar vi att du använder en knapp med data-bs-targetattributet. Även om det inte rekommenderas ur en semantisk synvinkel, kan du också använda en länk med hrefattributet (och ett role="button"). I båda fallen data-bs-toggle="collapse"krävs.

Some placeholder content for the collapse component. This panel is hidden by default but revealed when the user activates the relevant trigger.
<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>

Flera mål

En <button>eller <a>kan visa och dölja flera element genom att referera till dem med en väljare i dess hrefeller data-bs-targetattribut. Flera <button>eller <a>kan visa och dölja ett element om var och en refererar till det med sitt hrefeller data-bs-targetattribut

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.
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.
<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>

Tillgänglighet

Var noga med att lägga aria-expandedtill kontrollelementet. Det här attributet förmedlar explicit det aktuella tillståndet för det hopfällbara elementet kopplat till kontrollen till skärmläsare och liknande hjälpmedelstekniker. Om det hopfällbara elementet är stängt som standard ska attributet på kontrollelementet ha värdet aria-expanded="false". Om du har angett att det hopfällbara elementet ska vara öppet som standard med showklassen, ställ in aria-expanded="true"på kontrollen istället. Insticksprogrammet växlar automatiskt detta attribut på kontrollen baserat på om det hopfällbara elementet har öppnats eller stängts (via JavaScript, eller för att användaren utlöste ett annat kontrollelement som också är kopplat till samma hopfällbara element). Om kontrollelementets HTML-element inte är en knapp (t.ex. en <a>eller <div>), attributetrole="button"bör läggas till elementet.

Om ditt kontrollelement är inriktat på ett enstaka hopfällbart element – ​​dvs data-bs-targetattributet pekar på en idväljare – bör du lägga till aria-controlsattributet till kontrollelementet som innehåller iddet hopfällbara elementet. Moderna skärmläsare och liknande hjälpmedel använder detta attribut för att ge användarna ytterligare genvägar för att navigera direkt till själva det hopfällbara elementet.

Observera att Bootstraps nuvarande implementering inte täcker de olika valfria tangentbordsinteraktionerna som beskrivs i WAI-ARIA Authoring Practices 1.1 dragspelsmönster - du måste inkludera dessa själv med anpassad JavaScript.

Sass

Variabler

$transition-collapse:         height .35s ease;

Klasser

Kollapsövergångsklasser kan hittas i scss/_transitions.scsseftersom dessa delas över flera komponenter (kollaps och dragspel).

.collapse {
  &:not(.show) {
    display: none;
  }
}

.collapsing {
  height: 0;
  overflow: hidden;
  @include transition($transition-collapse);
}

Användande

Kollapspluginen använder några klasser för att hantera tunga lyft:

  • .collapsedöljer innehållet
  • .collapse.showvisar innehållet
  • .collapsingläggs till när övergången startar och tas bort när den är klar

Dessa klasser finns i _transitions.scss.

Via dataattribut

Lägg bara till data-bs-toggle="collapse"och ett data-bs-targettill elementet för att automatiskt tilldela kontroll över ett eller flera hopfällbara element. Attributet data-bs-targetaccepterar en CSS-väljare att tillämpa komprimeringen på. Se till att lägga till klassen collapsei det hopfällbara elementet. Om du vill att den ska öppnas som standard lägger du till den extra klassen show.

Lägg till dataattributet för att lägga till dragspelsliknande grupphantering till ett hopfällbart område data-bs-parent="#selector". Se demon för att se detta i aktion.

Via JavaScript

Aktivera manuellt med:

var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
  return new bootstrap.Collapse(collapseEl)
})

alternativ

Alternativ kan skickas via dataattribut eller JavaScript. För dataattribut, lägg till alternativnamnet till data-bs-, som i data-bs-parent="".

namn Typ Standard Beskrivning
parent väljare | jQuery-objekt | DOM-element false Om förälder tillhandahålls kommer alla hopfällbara element under den angivna överordnade att stängas när detta hopfällbara objekt visas. (liknar traditionellt dragspelsbeteende - detta beror på cardklassen). Attributet måste ställas in på det hopfällbara målet.
toggle booleskt true Växlar det hopfällbara elementet vid anrop

Metoder

Asynkrona metoder och övergångar

Alla API - metoder är asynkrona och startar en övergång . De återvänder till den som ringer så snart övergången har påbörjats men innan den slutar . Dessutom kommer ett metodanrop på en övergångskomponent att ignoreras .

Se vår JavaScript-dokumentation för mer information .

Aktiverar ditt innehåll som ett hopfällbart element. Accepterar ett valfritt alternativ object.

Du kan skapa en kollapsinstans med konstruktorn, till exempel:

var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
  toggle: false
})
Metod Beskrivning
toggle Växlar ett hopfällbart element till att visas eller döljas. Återgår till den som ringer innan det hopfällbara elementet faktiskt har visats eller dolt (dvs innan händelsen shown.bs.collapseeller hidden.bs.collapseinträffar).
show Visar ett hopfällbart element. Återgår till den som ringer innan det hopfällbara elementet faktiskt har visats (t.ex. innan shown.bs.collapsehändelsen inträffar).
hide Döljer ett hopfällbart element. Återgår till den som ringer innan det hopfällbara elementet faktiskt har dolts (t.ex. innan hidden.bs.collapsehändelsen inträffar).
dispose Förstör ett elements kollaps. (Tar bort lagrad data på DOM-elementet)
getInstance Statisk metod som låter dig få kollapsinstansen kopplad till ett DOM-element, du kan använda det så här:bootstrap.Collapse.getInstance(element)
getOrCreateInstance Statisk metod som returnerar en kollapsinstans som är kopplad till ett DOM-element eller skapar en ny om den inte initierades. Du kan använda det så här:bootstrap.Collapse.getOrCreateInstance(element)

evenemang

Bootstraps kollapsklass avslöjar några händelser för att koppla in kollapsfunktionalitet.

Event typ Beskrivning
show.bs.collapse Denna händelse aktiveras omedelbart när showinstansmetoden anropas.
shown.bs.collapse Den här händelsen utlöses när ett kollapselement har gjorts synligt för användaren (väntar på att CSS-övergångar ska slutföras).
hide.bs.collapse Denna händelse aktiveras omedelbart när hidemetoden har anropats.
hidden.bs.collapse Den här händelsen utlöses när ett kollapselement har dolts för användaren (väntar på att CSS-övergångar ska slutföras).
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
  // do something...
})