Collapse toggle via JavaScript in Bootsrap

Introduction

Collapse toggle lets you show or hide content smoothly on a webpage. It helps keep pages neat and easy to use.

You want to hide extra details until the user clicks a button.

You have a FAQ section where answers appear when questions are clicked.

You want to save space on a page by hiding long text or images.

You want to create a menu that expands and collapses on small screens.

Syntax

Bootsrap

var myCollapse = new bootstrap.Collapse(element, options);

// To toggle collapse via JavaScript:
myCollapse.toggle();

element is the HTML element you want to collapse or expand.

options can include {toggle: true} to open immediately or false to stay closed.

Examples

This toggles the collapse state of the element with ID 'myContent'.

Bootsrap

var myCollapse = new bootstrap.Collapse(document.getElementById('myContent'));
myCollapse.toggle();

Creates a collapse object that starts hidden and can be toggled later.

Bootsrap

var myCollapse = new bootstrap.Collapse(document.querySelector('.collapse'), {toggle: false});
// Starts collapsed, toggle later with myCollapse.toggle()

Sample Program

This example creates a button that toggles the visibility of some content below it. The content starts hidden. When you click the button, the content smoothly appears or disappears. The button text and aria-expanded attribute update for accessibility.

Bootsrap

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Bootstrap Collapse Toggle Example</title>
  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet" />
</head>
<body>
  <main class="container py-4">
    <h1>Collapse Toggle via JavaScript</h1>
    <button id="toggleBtn" class="btn btn-primary mb-3" aria-expanded="false" aria-controls="collapseExample">
      Show Details
    </button>
    <div class="collapse" id="collapseExample">
      <div class="card card-body">
        This content is hidden or shown when you click the button above.
      </div>
    </div>
  </main>

  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
  <script>
    const collapseElement = document.getElementById('collapseExample');
    const toggleBtn = document.getElementById('toggleBtn');
    const bsCollapse = new bootstrap.Collapse(collapseElement, { toggle: false });

    toggleBtn.addEventListener('click', () => {
      bsCollapse.toggle();
      const expanded = toggleBtn.getAttribute('aria-expanded') === 'true';
      toggleBtn.setAttribute('aria-expanded', String(!expanded));
      toggleBtn.textContent = expanded ? 'Show Details' : 'Hide Details';
    });
  </script>
</body>
</html>

Important Notes

Always include aria-expanded and aria-controls on toggle buttons for accessibility.

Use Bootstrap's bundled JavaScript file to get all features without extra setup.

Start with {toggle: false} if you want the content hidden initially.

Summary

Use new bootstrap.Collapse(element) to control collapse with JavaScript.

Call toggle() to show or hide content smoothly.

Update button text and aria attributes for a better user experience.

Practice

1. What does the toggle() method do when used with new bootstrap.Collapse(element) in Bootstrap?

easy

A. It reloads the entire page.

B. It shows the hidden content if collapsed, or hides it if shown.

C. It permanently disables the collapse functionality.

D. It changes the color of the collapsed content.

Solution

1. Step 1: Understand the collapse object

   The new bootstrap.Collapse(element) creates a controller for the collapsible content.

2. Step 2: Role of toggle() method

   The toggle() method switches the content between visible and hidden states smoothly.

3. Final Answer:

   It shows the hidden content if collapsed, or hides it if shown. -> Option B

4. Quick Check:

   toggle() switches collapse state [OK]

Hint: toggle() flips collapse open or closed [OK]

Common Mistakes:

• Thinking toggle disables collapse
• Confusing toggle with page reload
• Assuming toggle changes styles only

2. Which of the following is the correct way to create a Bootstrap collapse instance for an element with id myCollapse in JavaScript?

easy

A. const collapse = new bootstrap.Collapse('myCollapse');

B. const collapse = bootstrap.Collapse('#myCollapse');

C. const collapse = new bootstrap.Collapse(document.getElementById('myCollapse'));

D. const collapse = new Collapse('myCollapse');

Solution

1. Step 1: Identify the element reference

   The Bootstrap Collapse constructor requires a DOM element, not a selector string.

2. Step 2: Correct syntax for element selection

   Using document.getElementById('myCollapse') returns the element to pass to the constructor.

3. Final Answer:

   const collapse = new bootstrap.Collapse(document.getElementById('myCollapse')); -> Option C

4. Quick Check:

   Pass DOM element, not selector string [OK]

Hint: Use getElementById to pass element, not string [OK]

Common Mistakes:

• Passing selector string instead of element
• Omitting 'new' keyword
• Using undefined Collapse without bootstrap prefix

3. Given the following code, what will be the visible state of the collapsible content after the button is clicked once?

const collapse = new bootstrap.Collapse(document.getElementById('content'), { toggle: false });
document.getElementById('toggleBtn').addEventListener('click', () => {
  collapse.toggle();
});

The content is initially hidden.

medium

A. The content will become visible.

B. The content will remain hidden.

C. The content will be removed from the DOM.

D. An error will occur because toggle is false.

Solution

1. Step 1: Understand initial state and options

   The content starts hidden and toggle: false means it won't auto-toggle on creation.

2. Step 2: Effect of calling toggle() on click

   Calling toggle() manually switches the state, so hidden content becomes visible.

3. Final Answer:

   The content will become visible. -> Option A

4. Quick Check:

   Manual toggle() shows hidden content [OK]

Hint: toggle() always flips visibility regardless of options [OK]

Common Mistakes:

• Thinking toggle:false disables toggle() method
• Assuming content stays hidden without auto toggle
• Confusing toggle() with remove()

4. Identify the error in this code snippet that tries to toggle a Bootstrap collapse:

const collapse = new bootstrap.Collapse('content');
document.getElementById('btn').addEventListener('click', () => {
  collapse.toggle();
});

medium

A. The selector 'content' should be a DOM element, not a string.

B. The toggle() method is not available on collapse instances.

C. The event listener is attached to the wrong element.

D. Missing parentheses when calling toggle.

Solution

1. Step 1: Check constructor argument

   The constructor expects a DOM element, but 'content' is a string selector, which is incorrect.

2. Step 2: Correct way to pass element

   Use document.getElementById('content') to get the element before passing it.

3. Final Answer:

   The selector 'content' should be a DOM element, not a string. -> Option A

4. Quick Check:

   Pass DOM element, not string selector [OK]

Hint: Always pass DOM element, not string selector [OK]

Common Mistakes:

• Passing string selector instead of element
• Assuming toggle() is unavailable
• Incorrect event listener target

5. You want to toggle a Bootstrap collapse and update the button text between 'Show' and 'Hide' accordingly. Which JavaScript code correctly achieves this?

const collapse = new bootstrap.Collapse(document.getElementById('panel'), { toggle: false });
const btn = document.getElementById('toggleBtn');
btn.addEventListener('click', () => {
  collapse.toggle();
  if (btn.textContent === 'Show') {
    btn.textContent = 'Hide';
  } else {
    btn.textContent = 'Show';
  }
});

hard

A. The collapse instance must be recreated inside the click event.

B. The button text update should happen before calling toggle().

C. You must use btn.innerHTML instead of textContent.

D. This code works correctly to toggle and update button text.

Solution

1. Step 1: Check toggle and button text update order

   The code calls collapse.toggle() then updates the button text based on current text, which is logical.

2. Step 2: Validate textContent usage and event setup

   Using textContent is correct for plain text updates, and the collapse instance is created once outside the event.

3. Final Answer:

   This code works correctly to toggle and update button text. -> Option D

4. Quick Check:

   Toggle then update textContent works [OK]

Hint: Toggle first, then update button text [OK]

Common Mistakes:

• Updating text before toggle causing mismatch
• Using innerHTML unnecessarily
• Recreating collapse instance on every click