Pereiti prie pagrindinio turinio Pereiti prie dokumentų naršymo
in English

Sutraukti

Perjunkite projekto turinio matomumą naudodami kelias klases ir „JavaScript“ papildinius.

Kaip tai veikia

Sutraukti JavaScript įskiepis naudojamas turiniui rodyti ir slėpti. Mygtukai arba inkarai naudojami kaip aktyvikliai, susieti su konkrečiais jūsų perjungiamais elementais. Sutraukus elementą, heightjo dabartinė vertė bus animuota į 0. Atsižvelgiant į tai, kaip CSS apdoroja animacijas, negalite naudoti paddingelemento .collapse. Vietoj to naudokite klasę kaip nepriklausomą vyniojimo elementą.

Šio komponento animacijos efektas priklauso nuo prefers-reduced-motionmedijos užklausos. Žr . mūsų pritaikymo neįgaliesiems dokumentacijos skyrių „Sumažintas judėjimas“ .

Pavyzdys

Spustelėkite toliau pateiktus mygtukus, kad peržiūrint klasę būtų rodomas ir paslėptas kitas elementas:

  • .collapseslepia turinį
  • .collapsingtaikomas perėjimų metu
  • .collapse.showrodo turinį

Paprastai rekomenduojame naudoti mygtuką su data-bs-targetatributu. Nors semantiniu požiūriu nerekomenduojama, taip pat galite naudoti nuorodą su hrefatributu (ir role="button"). Abiem atvejais data-bs-toggle="collapse"būtina.

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>

Horizontaliai

Sutraukimo įskiepis taip pat palaiko horizontalų sutraukimą. Įtraukite .collapse-horizontalmodifikatoriaus klasę, kad pakeistumėte ją width, heightir nustatykite widthtiesioginį antrinį elementą. Nedvejodami rašykite savo pasirinktinį Sass, naudokite eilutinius stilius arba naudokite mūsų pločio įrankius .

Atkreipkite dėmesį, kad nors toliau pateiktame pavyzdyje yra min-heightnustatyta, kad mūsų dokumentuose būtų išvengta pernelyg didelio perdažymo, tai nėra aiškiai reikalinga. Būtinas tik widthant antrinis elementas.

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

Keli taikiniai

A <button>arba <a>gali rodyti ir slėpti kelis elementus, nurodant juos naudodami parinkiklį jo hrefarba data-bs-targetatribute. Keli <button>arba <a>gali rodyti ir slėpti elementą, jei kiekvienas nurodo jį savo hrefarba data-bs-targetatributu

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>

Prieinamumas

Būtinai pridėkite aria-expandedprie valdymo elemento. Šis atributas aiškiai perteikia esamą sutraukiamo elemento, susieto su valdikliu, būseną ekrano skaitytuvams ir panašioms pagalbinėms technologijoms. Jei sutraukiamas elementas uždarytas pagal numatytuosius nustatymus, valdymo elemento atributo vertė turi būti aria-expanded="false". Jei naudodami showklasę nustatėte, kad sutraukiamasis elementas būtų atidarytas pagal numatytuosius nustatymus, aria-expanded="true"vietoj jo nustatykite valdiklį. Papildinys automatiškai perjungs šį valdiklio atributą, atsižvelgdamas į tai, ar sutraukiamas elementas buvo atidarytas ar uždarytas (naudojant „JavaScript“ arba todėl, kad vartotojas suaktyvino kitą valdymo elementą, taip pat susietą su tuo pačiu sutraukiamu elementu). Jei valdymo elemento HTML elementas nėra mygtukas (pvz., <a>arba <div>), atributasrole="button"reikia pridėti prie elemento.

Jei jūsų valdymo elementas taikomas vienam sutraukiamam elementui – ty data-bs-targetatributas nurodo idparinkiklį – turėtumėte pridėti aria-controlsatributą prie valdymo elemento, kuriame yra idsutraukiamas elementas. Šiuolaikiniai ekrano skaitytuvai ir panašios pagalbinės technologijos naudoja šį atributą, kad suteiktų vartotojams papildomų sparčiųjų klavišų, leidžiančių tiesiogiai pereiti prie paties sutraukiamo elemento.

Atminkite, kad dabartinis „Bootstrap“ diegimas neapima įvairių pasirenkamų klaviatūros sąveikų, aprašytų WAI-ARIA Authoring Practices 1.1 akordeono šablone – turėsite patys jas įtraukti į tinkintą „JavaScript“.

Sass

Kintamieji

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

Klasės

Sutraukti perėjimo klases galima rasti, scss/_transitions.scssnes jos yra bendrinamos keliuose komponentuose (sutraukimas ir akordeonas).

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

Naudojimas

Sutraukimo papildinys naudoja keletą klasių, kad galėtų susidoroti su sunkiu kėlimu:

  • .collapseslepia turinį
  • .collapse.showrodo turinį
  • .collapsingpridedamas, kai prasideda perėjimas, ir pašalinamas, kai jis baigiasi

Šias klases galima rasti _transitions.scss.

Per duomenų atributus

Tiesiog pridėkite data-bs-toggle="collapse"ir a data-bs-targetprie elemento, kad automatiškai priskirtumėte vieno ar daugiau sutraukiamų elementų valdymą. data-bs-targetAtributas priima CSS parinkiklį, kuriam taikomas sutraukimas . Būtinai pridėkite klasę collapseprie sutraukiamo elemento. Jei norite, kad jis būtų atidarytas pagal numatytuosius nustatymus, pridėkite papildomą klasę show.

Norėdami įtraukti į akordeoną panašų grupės valdymą sutraukiamoje srityje, pridėkite duomenų atributą data-bs-parent="#selector". Daugiau informacijos rasite akordeono puslapyje .

Per JavaScript

Įgalinti rankiniu būdu su:

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

Galimybės

Parinktys gali būti perduodamos naudojant duomenų atributus arba JavaScript. Duomenų atributams pridėkite parinkties pavadinimą prie data-bs-, kaip ir data-bs-parent="".

vardas Tipas Numatytas apibūdinimas
parent parinkiklis | jQuery objektas | DOM elementas false Jei pateikiamas pirminis elementas, visi sutraukiami elementai po nurodyto pirminio elemento bus uždaryti, kai bus parodytas šis sutraukiamas elementas. (panašus į tradicinį akordeono elgesį – tai priklauso nuo cardklasės). Atributas turi būti nustatytas tikslinėje sutraukiamoje srityje.
toggle loginis true Perjungia sutraukiamą elementą iškvietimo metu

Metodai

Asinchroniniai metodai ir perėjimai

Visi API metodai yra asinchroniniai ir pradeda perėjimą . Jie grįžta pas skambinantįjį, kai tik prasideda perėjimas, bet jam nepasibaigus . Be to, pereinamojo komponento metodo iškvietimas bus ignoruojamas .

Daugiau informacijos rasite mūsų JavaScript dokumentacijoje .

Suaktyvina turinį kaip sulankstomą elementą. Priima pasirenkamas parinktis object.

Galite sukurti sutraukimo egzempliorių naudodami konstruktorių, pavyzdžiui:

var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
  toggle: false
})
Metodas apibūdinimas
toggle Perjungia sutraukiamą elementą į rodomą arba paslėptą. Grįžta į skambinantįjį, kol sutraukiamas elementas iš tikrųjų buvo parodytas arba paslėptas (ty prieš įvykį shown.bs.collapsearba hidden.bs.collapseįvykį).
show Rodo sulankstomą elementą. Grįžta į skambinantįjį, kol iš tikrųjų nebuvo parodytas sutraukiamas elementas (pvz., prieš shown.bs.collapseįvykį).
hide Slepia sulankstomą elementą. Grįžta į skambinantįjį, kol sutraukiamas elementas iš tikrųjų buvo paslėptas (pvz., prieš įvykstant hidden.bs.collapseįvykiui).
dispose Sunaikina elemento žlugimą. (Pašalina saugomus duomenis DOM elemente)
getInstance Statinis metodas, leidžiantis gauti sutraukimo egzempliorių, susietą su DOM elementu, galite jį naudoti taip:bootstrap.Collapse.getInstance(element)
getOrCreateInstance Statinis metodas, kuris grąžina sutraukimo egzempliorių, susietą su DOM elementu, arba sukuria naują, jei jis nebuvo inicijuotas. Galite naudoti taip:bootstrap.Collapse.getOrCreateInstance(element)

Renginiai

„Bootstrap“ sutraukimo klasė atskleidžia keletą įvykių, kad būtų galima prisijungti prie sutraukimo funkcijos.

Renginio tipas apibūdinimas
show.bs.collapse Šis įvykis suaktyvinamas iš karto, kai showiškviečiamas egzemplioriaus metodas.
shown.bs.collapse Šis įvykis suaktyvinamas, kai sutraukimo elementas tampa matomas vartotojui (lauks, kol bus baigti CSS perėjimai).
hide.bs.collapse Šis įvykis suaktyvinamas iš karto, kai hideiškviečiamas metodas.
hidden.bs.collapse Šis įvykis suaktyvinamas, kai sutraukimo elementas buvo paslėptas nuo vartotojo (lauks, kol bus baigti CSS perėjimai).
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
  // do something...
})