Modal JavaScript API in Bootsrap

Introduction

A modal is a popup box that appears on top of the page to show important information or ask for user action without leaving the current page.

To show a confirmation message before deleting something.

To display a form without navigating away from the page.

To show extra details or images without cluttering the main page.

To alert users about important updates or warnings.

To get quick input from users without loading a new page.

Syntax

Bootsrap

var myModal = new bootstrap.Modal(document.getElementById('myModalId'), options);
myModal.show();
myModal.hide();

document.getElementById('myModalId') selects the modal element in your HTML.

options is optional and can control behavior like keyboard closing or backdrop.

Examples

This creates a modal instance for the element with id 'exampleModal' and opens it.

Bootsrap

var myModal = new bootstrap.Modal(document.getElementById('exampleModal'));
myModal.show();

This modal will not close when the user presses the keyboard escape key.

Bootsrap

var myModal = new bootstrap.Modal(document.getElementById('exampleModal'), {keyboard: false});
myModal.show();

This hides the modal if it is currently shown.

Bootsrap

var myModal = new bootstrap.Modal(document.getElementById('exampleModal'));
myModal.hide();

Sample Program

This example shows a button that opens a modal popup when clicked. The modal has a title, some text, and a close button. It uses Bootstrap 5's JavaScript API to control the modal.

Bootsrap

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Bootstrap Modal Example</title>
  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet" />
</head>
<body>
  <button id="openModalBtn" class="btn btn-primary">Open Modal</button>

  <div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="modalLabel" aria-hidden="true">
    <div class="modal-dialog">
      <div class="modal-content">
        <div class="modal-header">
          <h5 class="modal-title" id="modalLabel">Hello Modal</h5>
          <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
        </div>
        <div class="modal-body">
          This is a simple modal using Bootstrap's JavaScript API.
        </div>
        <div class="modal-footer">
          <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
        </div>
      </div>
    </div>
  </div>

  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
  <script>
    const modalElement = document.getElementById('exampleModal');
    const myModal = new bootstrap.Modal(modalElement);
    const openBtn = document.getElementById('openModalBtn');

    openBtn.addEventListener('click', () => {
      myModal.show();
    });
  </script>
</body>
</html>

Important Notes

Always include Bootstrap's CSS and JavaScript files for the modal to work.

Use data-bs-dismiss="modal" on buttons to close the modal automatically.

Modals trap keyboard focus for accessibility, so users can navigate inside the modal using the keyboard.

Summary

Modals show content on top of the page without leaving it.

Use Bootstrap's JavaScript API to open and close modals with code.

Modals improve user experience by focusing attention and keeping context.

Practice

1. What does the Bootstrap Modal JavaScript API primarily allow you to do?

easy

A. Resize the modal window automatically

B. Change the modal's background color dynamically

C. Open and close modals programmatically without user clicks

D. Add new buttons inside the modal content

Solution

1. Step 1: Understand the purpose of the Modal JavaScript API

   The API is designed to control modal visibility using JavaScript, not styling or content changes.

2. Step 2: Identify the main feature

   It allows opening and closing modals programmatically, which means without relying on user clicks.

3. Final Answer:

   Open and close modals programmatically without user clicks -> Option C

4. Quick Check:

   Modal API controls visibility [OK]

Hint: Modal API controls showing/hiding modals with code [OK]

Common Mistakes:

• Thinking it changes modal styles
• Assuming it resizes modals automatically
• Believing it adds content inside modals

2. Which of the following is the correct way to create a Bootstrap modal instance in JavaScript?

easy

A. const modal = new bootstrap.Modal(document.querySelector('#myModal'));

B. const modal = bootstrap.createModal('#myModal');

C. const modal = new Modal('#myModal');

D. const modal = bootstrap.Modal.open('#myModal');

Solution

1. Step 1: Recall Bootstrap modal instance creation syntax

   Bootstrap requires using the constructor with the element: new bootstrap.Modal(element).

2. Step 2: Match the correct syntax

   const modal = new bootstrap.Modal(document.querySelector('#myModal')); uses new bootstrap.Modal with a DOM element selected by querySelector, which is correct.

3. Final Answer:

   const modal = new bootstrap.Modal(document.querySelector('#myModal')); -> Option A

4. Quick Check:

   Use new bootstrap.Modal(element) [OK]

Hint: Use new bootstrap.Modal with a DOM element [OK]

Common Mistakes:

• Using non-existent bootstrap.createModal method
• Omitting 'new' keyword
• Passing selector string instead of element

3. Given the following code, what happens when modal.show() is called?

const modal = new bootstrap.Modal(document.getElementById('exampleModal'));
modal.show();

medium

A. The modal is hidden from the screen

B. Nothing happens because the modal is not initialized

C. An error occurs because show() is not a method

D. The modal with id 'exampleModal' is displayed on the screen

Solution

1. Step 1: Understand what modal.show() does

   The show() method displays the modal on the screen by changing its visibility and adding necessary classes.

2. Step 2: Confirm modal initialization

   The modal is correctly initialized with new bootstrap.Modal and a valid element, so show() works as expected.

3. Final Answer:

   The modal with id 'exampleModal' is displayed on the screen -> Option D

4. Quick Check:

   modal.show() displays modal [OK]

Hint: modal.show() always displays the modal [OK]

Common Mistakes:

• Confusing show() with hide()
• Assuming show() is not a method
• Not initializing modal before calling show()

4. What is wrong with this code snippet that tries to open a modal?

const modal = bootstrap.Modal(document.getElementById('myModal'));
modal.show();

medium

A. modal.show() cannot be called directly

B. Missing 'new' keyword when creating the modal instance

C. The selector '#myModal' is invalid

D. Incorrect method name; should be open() instead of show()

Solution

1. Step 1: Check modal instance creation syntax

   Bootstrap modal instances require the 'new' keyword: new bootstrap.Modal(element).

2. Step 2: Identify the error in the code

   The code misses 'new', so modal is undefined or not a proper instance, causing show() to fail.

3. Final Answer:

   Missing 'new' keyword when creating the modal instance -> Option B

4. Quick Check:

   Always use 'new' to create modal instances [OK]

Hint: Remember 'new' before bootstrap.Modal() [OK]

Common Mistakes:

• Using open() instead of show()
• Passing selector string instead of element
• Calling show() on undefined variable

5. You want to open a modal only after a user clicks a button, but also want to close it automatically after 3 seconds using Bootstrap's Modal JavaScript API. Which code snippet correctly achieves this?

hard

A. const modal = new bootstrap.Modal(document.getElementById('autoCloseModal'));
document.getElementById('openBtn').addEventListener('click', () => {
modal.show();
setTimeout(() => modal.hide(), 3000);
});

B. const modal = new bootstrap.Modal('#autoCloseModal');
document.getElementById('openBtn').onclick = () => {
modal.open();
setTimeout(() => modal.close(), 3000);
};

C. const modal = bootstrap.Modal(document.getElementById('autoCloseModal'));
document.getElementById('openBtn').addEventListener('click', () => {
modal.show();
setTimeout(() => modal.hide(), 3000);
});

D. const modal = new bootstrap.Modal(document.querySelector('autoCloseModal'));
document.getElementById('openBtn').addEventListener('click', () => {
modal.show();
setTimeout(() => modal.hide(), 3000);
});

Solution

1. Step 1: Verify modal instance creation

   const modal = new bootstrap.Modal(document.getElementById('autoCloseModal')); document.getElementById('openBtn').addEventListener('click', () => { modal.show(); setTimeout(() => modal.hide(), 3000); }); correctly uses 'new bootstrap.Modal' with a DOM element from getElementById, which is valid.

2. Step 2: Check event listener and timing

   The click event triggers modal.show(), then setTimeout calls modal.hide() after 3000ms (3 seconds), which matches the requirement.

3. Final Answer:

   const modal = new bootstrap.Modal(document.getElementById('autoCloseModal')); document.getElementById('openBtn').addEventListener('click', () => { modal.show(); setTimeout(() => modal.hide(), 3000); }); -> Option A

4. Quick Check:

   Use show() and hide() with setTimeout for auto-close [OK]

Hint: Use show() then setTimeout with hide() [OK]

Common Mistakes:

• Omitting 'new' keyword
• Using invalid methods like open() or close()
• Passing selector string instead of element