Introduction

Use a modal for dialog boxes, confirmation messages, or other content that can be called up. In order for the modal to work you have to add the Modal ID to the link of the trigger. To add a close button, just add the class .modal-close to your button.

Modal

Modals HTML Structure

  <!-- Modal Trigger -->
  <a class="waves-effect waves-light btn modal-trigger" href="#modal1">Modal</a>

  <!-- Modal Structure -->
  <div id="modal1" class="modal">
    <h4>Modal Header</h4>
    <p>A bunch of text</p>
    <a href="#" class="waves-effect btn-flat modal-close">Agree</a>
  </div>
          

jQuery Plugin Initialization

To open a modal using a trigger:

  $(document).ready(function(){
    // the "href" attribute of .modal-trigger must specify the modal ID that wants to be triggered
    $('.modal-trigger').leanModal();
  });
          

You can also open modals programatically, the below code will make your modal open on document ready:

  $(document).ready(function(){
    $('#modal1').openModal();
  });
          

You can also close them programatically:

  $(document).ready(function(){
    $('#modal1').closeModal();
  });
        

Options

You can customize the behavior of each modal using these options. For example, you can call a custom function to run when a modal is dismissed. To do this, just place your function in the intialization code as shown below.

  $('.modal-trigger').leanModal({
      dismissible: true // Modal can be dismissed by clicking outside of the modal
      opacity: .5, // Opacity of modal background
      in_duration: 300, // Transition in duration
      out_duration: 200, // Transition out duration
      ready: function() { alert('Ready'); }, // Callback for Modal open
      complete: function() { alert('Closed'); } // Callback for Modal close
    }
  );