Zusammenbruch

Wie es funktioniert

Das Kollaps-JavaScript-Plugin dient zum Ein- und Ausblenden von Inhalten. Schaltflächen oder Anker werden als Auslöser verwendet, die bestimmten Elementen zugeordnet sind, die Sie umschalten. Das Reduzieren eines Elements animiert das heightvon seinem aktuellen Wert zu 0. Angesichts der Art und Weise, wie CSS mit Animationen umgeht, können Sie sie nicht paddingfür ein .collapseElement verwenden. Verwenden Sie stattdessen die Klasse als unabhängiges Wrapping-Element.

Beispiel

Klicken Sie auf die Schaltflächen unten, um ein anderes Element über Klassenänderungen ein- und auszublenden:

• .collapseInhalte verbirgt
• .collapsingwird während der Übergänge angewendet
• .collapse.showzeigt Inhalt

Generell empfehlen wir die Verwendung einer Schaltfläche mit dem data-bs-targetAttribut. Obwohl semantisch nicht empfehlenswert, können Sie auch einen Link mit dem hrefAttribut (und einem role="button") verwenden. In beiden Fällen ist das data-bs-toggle="collapse"erforderlich.

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

Horizontal

Das Kollaps-Plugin unterstützt auch das horizontale Kollabieren. Fügen Sie die Modifikatorklasse hinzu, um die anstelle von .collapse-horizontalzu übergehen , und legen Sie a für das unmittelbar untergeordnete Element fest. Fühlen Sie sich frei, Ihren eigenen benutzerdefinierten Sass zu schreiben, Inline-Stile zu verwenden oder unsere Breiten-Dienstprogramme zu verwenden .widthheightwidth

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

Mehrere Ziele

Ein <button>or <a>kann mehrere Elemente ein- und ausblenden, indem es sie mit einem Selektor in seinem hrefor - data-bs-targetAttribut referenziert. Mehrere <button>oder <a>können ein Element ein- und ausblenden, wenn sie es jeweils mit ihrem hrefor - data-bs-targetAttribut referenzieren

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

Barrierefreiheit

aria-expandedAchten Sie darauf , das Steuerelement hinzuzufügen . Dieses Attribut übermittelt explizit den aktuellen Status des reduzierbaren Elements, das an das Steuerelement gebunden ist, an Bildschirmlesegeräte und ähnliche Hilfstechnologien. Wenn das reduzierbare Element standardmäßig geschlossen ist, sollte das Attribut des Steuerelements den Wert haben aria-expanded="false". Wenn Sie festgelegt haben, dass das reduzierbare Element mithilfe der showKlasse standardmäßig geöffnet ist, legen Sie aria-expanded="true"stattdessen das Steuerelement fest. Das Plug-in schaltet dieses Attribut auf dem Steuerelement automatisch um, je nachdem, ob das reduzierbare Element geöffnet oder geschlossen wurde (über JavaScript oder weil der Benutzer ein anderes Steuerelement ausgelöst hat, das ebenfalls mit demselben reduzierbaren Element verknüpft ist). Wenn das HTML-Element des Steuerelements keine Schaltfläche ist (z. B. ein <a>oder <div>), wird das Attributrole="button"sollte dem Element hinzugefügt werden.

Wenn Ihr Steuerelement auf ein einzelnes reduzierbares Element abzielt – dh das data-bs-targetAttribut auf einen idSelektor zeigt – sollten Sie das aria-controlsAttribut dem Steuerelement hinzufügen, das die iddes reduzierbaren Elements enthält. Moderne Screenreader und ähnliche Hilfstechnologien nutzen dieses Attribut, um Benutzern zusätzliche Verknüpfungen bereitzustellen, mit denen sie direkt zum reduzierbaren Element selbst navigieren können.

Beachten Sie, dass die aktuelle Implementierung von Bootstrap die verschiedenen optionalen Tastaturinteraktionen, die im Akkordeonmuster des ARIA Authoring Practices Guide beschrieben sind , nicht abdeckt – Sie müssen diese selbst mit benutzerdefiniertem JavaScript einbinden.

Sass

Variablen

$transition-collapse:         height .35s ease;
$transition-collapse-width:   width .35s ease;

Klassen

Collapse-Übergangsklassen sind in zu finden, scss/_transitions.scssda diese von mehreren Komponenten (collapse und Accordion) gemeinsam genutzt werden.

.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);
  }
}

Verwendungszweck

Das Kollaps-Plugin verwendet einige Klassen, um das schwere Heben zu bewältigen:

• .collapseverbirgt den Inhalt
• .collapse.showzeigt den Inhalt
• .collapsingwird hinzugefügt, wenn der Übergang beginnt, und entfernt, wenn er endet

Diese Klassen finden Sie in _transitions.scss.

Über Datenattribute

Fügen Sie dem Element einfach data-bs-toggle="collapse"und ein hinzu data-bs-target, um automatisch die Steuerung eines oder mehrerer zusammenklappbarer Elemente zuzuweisen. Das data-bs-targetAttribut akzeptiert einen CSS-Selektor, auf den die Minimierung angewendet wird. Stellen Sie sicher, dass Sie die Klasse collapsedem zusammenklappbaren Element hinzufügen. Wenn Sie möchten, dass es standardmäßig geöffnet ist, fügen Sie die zusätzliche Klasse hinzu show.

Um einem zusammenklappbaren Bereich eine akkordeonartige Gruppenverwaltung hinzuzufügen, fügen Sie das Datenattribut hinzu data-bs-parent="#selector". Weitere Informationen finden Sie auf der Akkordeonseite .

Über JavaScript

Manuell aktivieren mit:

const collapseElementList = document.querySelectorAll('.collapse')
const collapseList = [...collapseElementList].map(collapseEl => new bootstrap.Collapse(collapseEl))

Optionen

Da Optionen über Datenattribute oder JavaScript übergeben werden können, können Sie einen Optionsnamen data-bs-wie in anhängen data-bs-animation="{value}". Stellen Sie sicher, dass Sie den Falltyp des Optionsnamens von " camelCase " in " kebab -case " ändern, wenn Sie die Optionen über Datenattribute übergeben. Verwenden Sie beispielsweise data-bs-custom-class="beautifier"anstelle von data-bs-customClass="beautifier".

Ab Bootstrap 5.2.0 unterstützen alle Komponenten ein experimentelles reserviertes Datenattribut, das eine data-bs-configeinfache Komponentenkonfiguration als JSON-String enthalten kann. Wenn ein Element über data-bs-config='{"delay":0, "title":123}'und data-bs-title="456"-Attribute verfügt, ist der endgültige titleWert 456und die separaten Datenattribute überschreiben die auf angegebenen Werte data-bs-config. Darüber hinaus können vorhandene Datenattribute JSON-Werte wie data-bs-delay='{"show":0,"hide":150}'.

Methoden

Aktiviert Ihren Inhalt als zusammenklappbares Element. Akzeptiert optionale Optionen object.

Sie können eine Collapse-Instanz mit dem Konstruktor erstellen, zum Beispiel:

const bsCollapse = new bootstrap.Collapse('#myCollapse', {
  toggle: false
})

Veranstaltungen

Die Collapse-Klasse von Bootstrap macht einige Ereignisse verfügbar, um sich in die Collapse-Funktionalität einzuklinken.

const myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', event => {
  // do something...
})