Prijeđi na glavni sadržaj Prijeđi na navigaciju dokumentima
Check
in English

Kolaps

Uključite/isključite vidljivost sadržaja u svom projektu pomoću nekoliko klasa i naših JavaScript dodataka.

Kako radi

Sažeti JavaScript dodatak koristi se za prikazivanje i sakrivanje sadržaja. Gumbi ili sidra koriste se kao okidači koji se preslikavaju na određene elemente koje mijenjate. Sažimanje elementa će animirati heightiz njegove trenutne vrijednosti u 0. S obzirom na to kako CSS obrađuje animacije, ne možete koristiti paddingna .collapseelementu. Umjesto toga, koristite klasu kao neovisni element za omatanje.

Učinak animacije ove komponente ovisi o prefers-reduced-motionmedijskom upitu. Pogledajte odjeljak smanjenog kretanja u našoj dokumentaciji o pristupačnosti .

Primjer

Pritisnite donje gumbe za prikaz ili skrivanje drugog elementa putem promjena klase:

  • .collapseskriva sadržaj
  • .collapsingprimjenjuje se tijekom prijelaza
  • .collapse.showprikazuje sadržaj

Općenito, preporučujemo korištenje gumba s data-bs-targetatributom. Iako se ne preporučuje sa semantičke točke gledišta, također možete koristiti vezu s hrefatributom (i role="button"). U oba slučaja data-bs-toggle="collapse"potrebno je.

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

Horizontalno

Dodatak za sažimanje također podržava horizontalno sažimanje. Dodajte .collapse-horizontalklasu modifikatora za prijelaz widthumjesto heighti postavite widthna neposredni podređeni element. Slobodno napišite vlastiti prilagođeni Sass, koristite ugrađene stilove ili koristite naše pomoćne programe za širinu .

Imajte na umu da, iako primjer u nastavku ima min-heightskup za izbjegavanje pretjeranog ponovnog bojanja u našim dokumentima, to nije izričito potrebno. Potreban je samo widthon the child element.

This is some placeholder content for a horizontal collapse. It's hidden by default and shown when triggered.
html
<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>

Više ciljeva

A <button>ili <a>može prikazati i sakriti više elemenata upućivanjem na njih selektorom u svom hrefili data-bs-targetatributu. Višestruki <button>ili <a>mogu prikazati i sakriti element ako svaki od njih upućuje na njega svojim hrefili data-bs-targetatributom

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

Pristupačnost

Obavezno dodajte aria-expandedu kontrolni element. Ovaj atribut eksplicitno prenosi trenutačno stanje sklopivog elementa povezanog s kontrolom čitačima zaslona i sličnim pomoćnim tehnologijama. Ako je sklopivi element zatvoren prema zadanim postavkama, atribut na kontrolnom elementu trebao bi imati vrijednost aria-expanded="false". Ako ste sklopivi element postavili da bude otvoren prema zadanim postavkama pomoću showklase, aria-expanded="true"umjesto toga postavite na kontrolu. Dodatak će automatski prebaciti ovaj atribut na kontrolu na temelju toga je li sklopivi element otvoren ili zatvoren (preko JavaScripta ili zato što je korisnik pokrenuo drugi kontrolni element također povezan s istim sklopivim elementom). Ako HTML element kontrolnog elementa nije gumb (npr. <a>ili <div>), atributrole="button"treba dodati elementu.

Ako vaš kontrolni element cilja na jedan sklopivi element – ​​tj. data-bs-targetatribut pokazuje na idselektor – trebali biste dodati aria-controlsatribut u kontrolni element koji sadrži idelement sklopivog elementa. Moderni čitači zaslona i slične pomoćne tehnologije koriste ovaj atribut kako bi korisnicima pružili dodatne prečace za izravnu navigaciju do samog sklopivog elementa.

Imajte na umu da Bootstrapova trenutna implementacija ne pokriva razne izborne interakcije tipkovnice opisane u uzorku harmonike ARIA Authoring Practices Guide - morat ćete ih sami uključiti s prilagođenim JavaScriptom.

Sass

Varijable

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

Nastava

Klase prijelaza sažimanja mogu se pronaći u scss/_transitions.scssbudući da se dijele na više komponenti (sažimanje i harmonika).

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

Korištenje

Dodatak za kolapsiranje koristi nekoliko klasa za rukovanje teškim dizanjem:

  • .collapseskriva sadržaj
  • .collapse.showprikazuje sadržaj
  • .collapsingdodaje se kada prijelaz započne, a uklanja se kada završi

Ove se klase mogu pronaći u _transitions.scss.

Preko atributa podataka

Samo dodajte data-bs-toggle="collapse"i data-bs-targetelementu da biste automatski dodijelili kontrolu nad jednim ili više sklopivih elemenata. Atribut data-bs-targetprihvaća CSS selektor na koji se primjenjuje sažimanje. Obavezno dodajte klasu collapsesklopivom elementu. Ako želite da se prema zadanim postavkama otvori, dodajte dodatnu klasu show.

Za dodavanje grupnog upravljanja poput harmonike u sklopivi prostor dodajte atribut podataka data-bs-parent="#selector". Više informacija potražite na stranici o harmonici .

Preko JavaScripta

Omogućite ručno pomoću:

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

Mogućnosti

Kako se opcije mogu proslijediti putem atributa podataka ili JavaScripta, možete dodati naziv opcije u data-bs-, kao u data-bs-animation="{value}". Obavezno promijenite vrstu velikih i malih slova naziva opcije iz “ camelCase ” u “ kebab-case ” kada prosljeđujete opcije putem atributa podataka. Na primjer, koristite data-bs-custom-class="beautifier"umjesto data-bs-customClass="beautifier".

Od Bootstrapa 5.2.0, sve komponente podržavaju eksperimentalni atribut rezerviranih podataka data-bs-configkoji može sadržavati jednostavnu konfiguraciju komponente kao JSON niz. Kada element ima atribute data-bs-config='{"delay":0, "title":123}'i data-bs-title="456", konačna titlevrijednost će biti 456, a zasebni atributi podataka nadjačat će vrijednosti dane na data-bs-config. Osim toga, postojeći atributi podataka mogu sadržavati JSON vrijednosti poput data-bs-delay='{"show":0,"hide":150}'.

Ime Tip Zadano Opis
parent selektor, DOM element null Ako je naveden nadređeni element, tada će svi sklopivi elementi pod navedenim nadređenim elementom biti zatvoreni kada se prikaže ova sklopiva stavka. (slično tradicionalnom ponašanju harmonike - ovo ovisi o cardklasi). Atribut mora biti postavljen na ciljno sklopivo područje.
toggle Booleov true Prebacuje sklopivi element na poziv.

Metode

Asinkrone metode i prijelazi

Sve API metode su asinkrone i pokreću prijelaz . Vraćaju se pozivatelju čim prijelaz započne, ali prije nego što završi . Osim toga, poziv metode na prijelaznoj komponenti bit će zanemaren .

Pogledajte našu JavaScript dokumentaciju za više informacija .

Aktivira vaš sadržaj kao sklopivi element. Prihvaća izborne opcije object.

Možete stvoriti instancu kolapsa pomoću konstruktora, na primjer:

const bsCollapse = new bootstrap.Collapse('#myCollapse', {
  toggle: false
})
metoda Opis
dispose Uništava kolaps elementa. (Uklanja pohranjene podatke na DOM elementu)
getInstance Statička metoda koja vam omogućuje da dobijete instancu kolapsa povezanu s DOM elementom, možete je koristiti ovako: bootstrap.Collapse.getInstance(element).
getOrCreateInstance Statička metoda koja vraća instancu kolapsa pridruženu DOM elementu ili stvara novu u slučaju da nije inicijalizirana. Možete ga koristiti ovako: bootstrap.Collapse.getOrCreateInstance(element).
hide Skriva sklopivi element. Vraća se pozivatelju prije nego što je sklopivi element zapravo skriven (npr. prije nego što se hidden.bs.collapsedogađaj dogodi).
show Prikazuje sklopivi element. Vraća se pozivatelju prije nego što je sklopivi element stvarno prikazan (npr. prije nego što se shown.bs.collapsedogađaj dogodi).
toggle Prebacuje sklopivi element na prikazan ili skriven. Vraća se pozivatelju prije nego što se sklopivi element stvarno prikaže ili sakrije (tj. prije nego što se dogodi događaj shown.bs.collapseili ).hidden.bs.collapse

Događaji

Bootstrapova kolaps klasa izlaže nekoliko događaja za spajanje na kolaps funkcionalnost.

Vrsta događaja Opis
hide.bs.collapse Ovaj događaj se pokreće odmah nakon hidepoziva metode.
hidden.bs.collapse Ovaj se događaj pokreće kada je element sažimanja skriven od korisnika (pričekat će da se CSS prijelazi završe).
show.bs.collapse Ovaj događaj aktivira se odmah kada showse pozove metoda instance.
shown.bs.collapse Ovaj se događaj pokreće kada se element sažimanja učini vidljivim korisniku (pričekat će da se CSS prijelazi završe).
const myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', event => {
  // do something...
})