Sidenav MDB Pro component

Sidenav - Bootstrap 5 & Material Design 2.0 navigation

The side navigation component provides an easy way to navigate through your website. Its appearance & behaviour are easily adjustable with data-attributes and methods - additional functionality such as touch events and focus trap (in an over mode) are available out of the box.

Note: Read the API tab to find all available options and advanced customization

View full screen demo

Basic example

In the basic version, the side navigation will appear over your website's content after clicking on a toggler.

Note: Use show and hide methods to toggle navigation with JavaScript.


          <!-- Sidenav -->
          <div
            id="sidenav-1"
            class="sidenav"
            role="navigation"
            data-hidden="false"
          >
            <ul class="sidenav-menu">
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 1</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin fa-fw mr-3"></i><span>Category 1</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 2</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 3</a>
                  </li>
                </ul>
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin-wink fa-fw mr-3"></i><span>Category 2</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 4</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"
                      >Link 5</a
                    >
                  </li>
                </ul>
              </li>
            </ul>
          </div>
          <!-- Sidenav -->

          <!-- Toggler -->
          <button
            data-toggle="sidenav"
            data-target="#sidenav-1"
            class="btn btn-primary"
            aria-controls="#sidenav-1"
            aria-haspopup="true"
          >
            <i class="fas fa-bars"></i>
          </button>
          <!-- Toggler -->
        

Positioning

While using the side and push modes, you can specify the selector for your page's content - this way, the component will automatically update paddings and margins. To customize this behaviour in a non-standard way, use a combination of media queries & update.mdb.sidenav event

Select mode:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc magna massa, ornare quis interdum a, cursus in quam. Quisque risus libero, cursus eget eros vitae, aliquam placerat velit. Vivamus luctus eros id sagittis luctus. Pellentesque felis nulla, rhoncus viverra nunc vitae, viverra aliquam ante. Ut feugiat mattis tempor.

          <div class="sidenav" data-mode="side" data-content="#content">
            ...
          </div>
          <div id="content">...</div>
        

Colors example

Setting the color attribute will change the background and font color of active/hovered links and categories.

Note: This option works for MDB 5 main colors - primary, secondary, warning, danger, success, info, dark and light.

Select color:


          <!-- Sidenav -->
          <div
            class="sidenav"
            data-color="secondary"
            role="navigation"
          >
          </div>
          <!-- Sidenav -->
        

Dark example

When using the darker background with the side navigation, we recommend setting the color attribute to "light" for better contrast.


          <!-- Sidenav -->
          <div
            class="sidenav"
            data-color="light"
            style="background-color: #2d2c2c"
            role="navigation"
          >
            ...
          </div>
          <!-- Sidenav -->
        

Inner scroll

Passing a selector of an inner element to the scrollContainer option will initialize MDB scrollbar only on this container (by default it's initialized on the sidenav's main element).


          <!-- Sidenav -->
          <div
            id="sidenav-3"
            class="sidenav"
            data-scroll-container="#scroll-container"
            data-mode="side"
            role="navigation"
          >
            <div class="text-center">
              <h3 class="py-4">Examples</h3>
              <hr class="m-0" />
            </div>
            <ul id="scroll-container" class="sidenav-menu">
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 1</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 2</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 3</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 4</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 5</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 6</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 7</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 8</span></a
                >
              </li>
            </ul>

            <div class="text-center" style="min-height: 3rem;">
              <hr class="mt-0 mb-2" />
              <small>mdbootstrap.com</small>
            </div>
          </div>
          <!-- Sidenav-->
        

Slim example

You can hide/show elements in the slim mode by setting data-slim attribute on them - depending on value they will be either visible only in a slim or an expanded mode. Elements without this attribute will appear in both modes.


          <!-- Sidenav-->
            <div
              id="sidenav-4"
              class="sidenav"
              data-mode="side"
              data-slim="true"
              data-slim-collapsed="true"
              data-content="#slim-content"
              role="navigation"
            >
            <ul class="sidenav-menu">
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i
                  ><span data-slim="false">Link 1</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin fa-fw mr-3"></i
                  ><span data-slim="false">Category 1</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 2</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 3</a>
                  </li>
                </ul>
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin-wink fa-fw mr-3"></i
                  ><span data-slim="false">Category 2</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 4</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 5</a>
                  </li>
                </ul>
              </li>
            </ul>
          </div>
          <!-- Sidenav-->

          <!-- Togglers -->
          <div id="slim-content">
            <button
              data-toggle="sidenav"
              data-target="#sidenav-4"
              class="btn btn-primary"
              aria-controls="#sidenav-4"
              aria-haspopup="true"
            >
              <i class="fas fa-bars"></i>
            </button>
            <button id="slim-toggler" class="btn btn-primary">
              Toggle slim
            </button>
          </div>
          <!-- Togglers -->
        

          //Initialize it with JS to make it instantly visible

          const slimInstance = new mdb.Sidenav(document.getElementById('sidenav-4'));
          slimInstance.show();

          document.getElementById('slim-toggler').addEventListener('click', () => {
            slimInstance.toggleSlim();
          })
        

Accordion example

Using accordion option will allow expanding only one category at once.


          <!-- Sidenav-->
          <div
            id="sidenav-5"
            class="sidenav"
            data-accordion="true"
            role="navigation"
          >
            <ul class="sidenav-menu">
              <li class="sidenav-item">
                <a class="sidenav-link">
                  <i class="far fa-smile fa-fw mr-3"></i><span>Link 1</span></a
                >
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin fa-fw mr-3"></i><span>Category 1</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 2</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 3</a>
                  </li>
                </ul>
              </li>
              <li class="sidenav-item">
                <a class="sidenav-link"
                  ><i class="fas fa-grin-wink fa-fw mr-3"></i><span>Category 2</span></a
                >
                <ul class="sidenav-collapse">
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 4</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link">Link 5</a>
                  </li>
                </ul>
              </li>
            </ul>
          </div>
          <!-- Sidenav-->

          <!-- Toggler -->
            <button
              data-toggle="sidenav"
              data-target="#sidenav-5"
              class="btn btn-primary"
              aria-controls="#sidenav-5"
              aria-haspopup="true"
            >
              <i class="fas fa-bars"></i>
            </button>
          <!-- Toggler -->
        

Groups

You can use more than one menu inside the side navigation - in this case, accordions will be independent of one another.


          <!-- Sidenav-->
          <div
            id="sidenav-6"
            class="sidenav"
            data-accordion="true"
            data-mode="side"
            role="navigation"
          >
          <ul class="sidenav-menu">
            <li class="sidenav-item">
              <a class="sidenav-link">
                <i class="far fa-smile fa-fw mr-3"></i><span>Link 1</span></a
              >
            </li>
            <li class="sidenav-item">
              <a class="sidenav-link"
                ><i class="fas fa-grin fa-fw mr-3"></i><span>Category 1</span></a
              >
              <ul class="sidenav-collapse">
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 2</a>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 3</a>
                </li>
              </ul>
            </li>
            <li class="sidenav-item">
              <a class="sidenav-link"
                ><i class="fas fa-grin-wink fa-fw mr-3"></i><span>Category 2</span></a
              >
              <ul class="sidenav-collapse">
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 4</a>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 5</a>
                </li>
              </ul>
            </li>
          </ul>
          <hr />
          <ul class="sidenav-menu">
            <li class="sidenav-item">
              <a class="sidenav-link">
                <i class="far fa-smile fa-fw mr-3"></i><span>Link 6</span></a
              >
            </li>
            <li class="sidenav-item">
              <a class="sidenav-link"
                ><i class="fas fa-grin fa-fw mr-3"></i><span>Category 3</span></a
              >
              <ul class="sidenav-collapse">
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 7</a>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 8</a>
                </li>
              </ul>
            </li>
            <li class="sidenav-item">
              <a class="sidenav-link"
                ><i class="fas fa-grin-wink fa-fw mr-3"></i><span>Category 4</span></a
              >
              <ul class="sidenav-collapse">
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 9</a>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">Link 10</a>
                </li>
              </ul>
            </li>
          </ul>
          </div>

          <!-- Sidenav-->

          <!-- Toggler -->
          <button
            data-toggle="sidenav"
            data-target="#sidenav-6"
            class="btn btn-primary"
            aria-controls="#sidenav-6"
            aria-haspopup="true"
          >
            <i class="fas fa-bars"></i>
          </button>
          <!-- Toggler -->
        

Right

Place the navigation on the other side by setting the right attribute to true.


          <div
            class="sidenav"
            data-right="true"
          >
            ...
          </div>
        

Full-screen examples

The following examples show various settings of the side navigation component in a full-screen mode.


1. Basic side navigation

Click the toggler to show the navigation (over mode).

View full screen demo

            <!-- Sidenav -->

            <div
              id="full-screen-example"
              class="sidenav"
            >
              <div class="mt-4">
                <div id="header-content" class="pl-3">
                  <img
                    src="https://mdbootstrap.com/img/Photos/Avatars/img%20(26).jpg"
                    alt="avatar"
                    class="rounded-circle img-fluid mb-3"
                    style="max-width: 50px;"
                  />

                  <h4>
                    Ann Smith
                  </h4>
                  <p>ann_s@mdbootstrap.com</p>
                </div>
                <hr class="mb-0" />
              </div>
              <div>
                <ul class="sidenav-menu">
                  <li class="sidenav-item">
                    <a class="sidenav-link" href="/"> <i class="fas fa-envelope fa-fw mr-3"></i>Inbox</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link" href="#test-link">
                      <i class="fas fa-paper-plane fa-fw mr-3"></i>Outbox</a
                    >
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-address-book fa-fw mr-3"></i>Contacts</a>
                    <ul class="sidenav-collapse">
                      <li class="sidenav-item">
                        <a class="sidenav-link">Family</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link" href="/previews/mdb-ui-kit/sidenav/1.html">Friends</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Work</a>
                      </li>
                    </ul>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-file fa-fw mr-3"></i>Drafts</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-heart fa-fw mr-3"></i>Favourites</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-star fa-fw mr-3"></i>Starred</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-trash fa-fw mr-3"></i>Trash</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-ban fa-fw mr-3"></i>Spam</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"><i class="fas fa-tag fa-fw mr-3"></i>Categories</a>
                    <ul class="sidenav-collapse">
                      <li class="sidenav-item">
                        <a class="sidenav-link">Social</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Notifications</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Recent</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Uploads</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Backups</a>
                      </li>
                      <li class="sidenav-item">
                        <a class="sidenav-link">Offers</a>
                      </li>
                    </ul>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-sticky-note fa-fw mr-3"></i>Notes</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-user-circle fa-fw mr-3"></i>Personal</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-ellipsis-h fa-fw mr-3"></i>More</a>
                  </li>
                </ul>
                <hr class="m-0" />
                <ul class="sidenav-menu">
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-cogs fa-fw mr-3"></i>Settings</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-user fa-fw mr-3"></i>Profile</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-shield-alt fa-fw mr-3"></i>Privacy</a>
                  </li>
                  <li class="sidenav-item">
                    <a class="sidenav-link"> <i class="fas fa-user-astronaut fa-fw mr-3"></i>Log out</a>
                  </li>
                </ul>
              </div>
              <div class="text-center" style="height: 100px;">
                <hr class="mb-4 mt-0" />
                <p>MDBootstrap.com</p>
              </div>
            </div>

            <!-- Sidenav -->

            <!-- Content -->

            <div class="mdb-page-content text-center page-intro bg-light">
              <div class="mask text-center py-5">
                <button
                  id="toggler"
                  class="btn btn-primary m-5"
                  data-toggle="sidenav"
                  data-target="#full-screen-example"
                >
                  <i class="fas fa-bars"></i>
                </button>
                <div>
                  <img class="rounded" src="https://mdbootstrap.com/img/Photos/Others/img%20(45).jpg" />
                </div>
              </div>
            </div>

            <!-- Content -->
          

            .page-intro {
              background-color: white;
              width: 100vw;
              height: 100vh;
            }
      
            mask {
              width: 100%;
            }
      
            .mask img {
              max-width: 80%;
            }
      
            @media (max-width: 660px) {
              .mask img {
                width: 100%;
              }
            }
          

2. Side navigation with a mode transition

Resize the window to change the mode from side to over.

View full screen demo

          <!-- Sidenav -->

          <div
            id="full-screen-example"
            class="sidenav bg-light"
            data-color="dark"
            data-mode="side"
            data-hidden="false"
            data-scroll-container="#scrollContainer"
          >
            <div class="mt-4">
              <div id="header-content" class="pl-3">
                <img
                  src="https://mdbootstrap.com/img/Photos/Avatars/img%20(23).jpg"
                  alt="avatar"
                  class="rounded-circle img-fluid mb-3"
                  style="max-width: 50px;"
                />

                <h4>
                  <span style="white-space: nowrap;">Ann Smith</span>
                </h4>
                <p>ann_s@mdbootstrap.com</p>
              </div>
              <hr class="mb-0" />
            </div>
            <div id="scrollContainer">
              <ul class="sidenav-menu">
                <li class="sidenav-item">
                  <a class="sidenav-link" href="/">
                    <i class="fas fa-envelope fa-fw mr-3"></i>Inbox</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-paper-plane fa-fw mr-3"></i>Outbox</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-address-book fa-fw mr-3"></i>Contacts</a
                  >
                  <ul class="sidenav-collapse">
                    <li class="sidenav-item">
                      <a class="sidenav-link">Family</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link" href="/previews/mdb-ui-kit/sidenav/2.html">Friends</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Work</a>
                    </li>
                  </ul>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-file fa-fw mr-3"></i>Drafts</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-heart fa-fw mr-3"></i>Favourites</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-star fa-fw mr-3"></i>Starred</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-trash fa-fw mr-3"></i>Trash</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-ban fa-fw mr-3"></i>Spam</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link"
                    ><i class="fas fa-tag fa-fw mr-3"></i>Categories</a
                  >
                  <ul class="sidenav-collapse">
                    <li class="sidenav-item">
                      <a class="sidenav-link">Social</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Notifications</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Recent</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Uploads</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Backups</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Offers</a>
                    </li>
                  </ul>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-sticky-note fa-fw mr-3"></i>Notes</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-user-circle fa-fw mr-3"></i>Personal</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-ellipsis-h fa-fw mr-3"></i>More</a
                  >
                </li>
              </ul>
              <hr class="m-0" />
              <ul class="sidenav-menu">
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-cogs fa-fw mr-3"></i>Settings</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-user fa-fw mr-3"></i>Profile</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-shield-alt fa-fw mr-3"></i>Privacy</a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link">
                    <i class="fas fa-user-astronaut fa-fw mr-3"></i>Log out</a
                  >
                </li>
              </ul>
            </div>
            <div class="text-center" style="height: 100px;">
              <hr class="mb-4 mt-0" />
              <p>MDBootstrap.com</p>
            </div>
          </div>

          <!-- Sidenav -->

          <!-- Content -->

          <div class="mdb-page-content text-center page-intro bg-light">
            <div class="text-center py-5">
              <h3 class="my-5">Resize to change the mode</h3>
              <div>
                <img class="rounded" src="https://mdbootstrap.com/img/Photos/Others/img%20(53).jpg" />
              </div>
              <button
                id="toggler"
                class="btn btn-dark mt-5"
                data-toggle="sidenav"
                data-target="#full-screen-example"
              >
                <i class="fas fa-bars"></i>
              </button>
            </div>
          </div>

          <!-- Content -->
        

          const sidenav = document.getElementById('full-screen-example');
          const sidenavInstance = mdb.Sidenav.getInstance(sidenav);

          let innerWidth = null;

          const setMode = (e) => {
            // Check necessary for Android devices
            if (window.innerWidth === innerWidth) {
              return;
            }

            innerWidth = window.innerWidth;

            if (window.innerWidth < 660) {
              sidenavInstance.changeMode('over');
              sidenavInstance.hide();
            } else {
              sidenavInstance.changeMode('side');
              sidenavInstance.show();
            }
          };

          setMode();

          // Event listeners

          window.addEventListener('resize', setMode);
        

          .page-intro {
            background-color: white;
            width: 100vw;
            min-height: 100vh;
          }
    
          img {
            max-width: 80%;
          }
    
          .mdb-page-content {
            padding-left: 240px;
            transition: padding 0.3s linear;
          }
    
          #toggler {
            display: none;
          }
    
          @media (max-width: 660px) {
            .mdb-page-content {
              padding-left: 0px;
            }
    
            #toggler {
              display: unset;
            }
    
            .mask img {
              width: 100%;
            }

            .sidenav[data-hidden='false'] {
              transform: translateX(-100%);
            }
          }
        

3. Slim side navigation (dark)

Non-expandable slim sidenav with a dark background and custom width.

View full screen demo

          <!-- Sidenav -->

          <div
            id="full-screen-example"
            class="sidenav bg-dark"
            data-color="light"
            data-slim="true"
            data-expandable="false"
            data-slim-collapsed="true"
            data-slim-width="90"
            data-mode="side"
            data-content="#content"
          >
            <div class="text-center mt-4">
              <a class="ripple rounded-circle" data-color="light" href="#">
                <img
                  src="https://mdbootstrap.com/img/Photos/Avatars/img%20(29).jpg"
                  alt="avatar"
                  class="rounded-circle img-fluid"
                  style="max-width: 60px;"
                />
              </a>
            </div>

            <hr />
            <ul class="sidenav-menu">
              <li class="sidenav-item my-3">
                <a class="sidenav-link p-0 d-flex justify-content-center">
                  <i class="far fa-heart fa-2x"></i
                ></a>
              </li>
              <li class="sidenav-item my-3">
                <a class="sidenav-link p-0 d-flex justify-content-center">
                  <i class="far fa-envelope fa-2x"></i
                ></a>
              </li>
              <li class="sidenav-item my-3">
                <a class="sidenav-link p-0 d-flex justify-content-center">
                  <i class="far fa-user fa-2x"></i
                ></a>
              </li>
              <li class="sidenav-item my-3">
                <a class="sidenav-link p-0 d-flex justify-content-center">
                  <i class="fa fa-cogs fa-2x"></i
                ></a>
              </li>
            </ul>
          </div>

          <!-- Sidenav -->

          <!-- Content -->

          <div id="content" class="page-intro">
            <div class="mask p-4 text-center">
              <h1>Natalie Smith</h1>
              <h2>Portfolio</h2>
            </div>
          </div>

          <!-- Content -->
        

          window.addEventListener('load', () => {
            const sidenav = document.getElementById('full-screen-example');
            const sidenavInstance = mdb.Sidenav.getInstance(sidenav);
    
            sidenavInstance.show();
          });
        

          .sidenav[data-slim-width='90'] {
            width: 90px;
          }
    
          .page-intro {
            background-image: url('https://mdbootstrap.com/img/Photos/Others/img%20(52).jpg');
            background-size: cover;
            background-position-x: center;
            background-color: white;
            width: 100vw;
            height: 100vh;
          }
    
          .mask {
            background-color: rgba(66, 66, 66, 0.4);
            width: 100%;
            height: 100%;
            color: rgba(255, 255, 255, 0.8);
          }
    
          .mask h1 {
            margin-top: 220px;
            font-size: 6rem;
          }
    
          .mask h2 {
            font-size: 2.8rem;
          }
    
          @media (max-width: 500px) {
            .mask h1 {
              font-size: 4rem;
            }
    
            .mask h2 {
              font-size: 2rem;
            }
          }
        

4. MDB Navigation

Navigation template based on MDB documentation with the following settings:

  • Hidden on screens smaller then 1400px
  • padding-left: 240px added via CSS to the header and main on the screens larger then 1400px to push the content out of the sidenav area
  • Sidenav toggler added to the Navbar and hidden on screen larger then 1400px
  • On screens smaller then 1400px sidenav mode changes from side to over.
View full screen demo

          <!--Main Navigation-->
          <header>
            <!-- Sidenav -->
            <div
              id="sidenav-1"
              class="sidenav"
              role="navigation"
              data-hidden="false"
              data-accordion="true"
            >
              <a
                class="ripple d-flex justify-content-center py-4"
                href="#!"
                data-ripple-color="primary"
              >
                <img
                  id="MDB-logo"
                  src="https://mdbootstrap.com/wp-content/uploads/2018/06/logo-mdb-jquery-small.png"
                  alt="MDB Logo"
                  draggable="false"
                />
              </a>

              <ul class="sidenav-menu">
                <li class="sidenav-item">
                  <a class="sidenav-link" href="">
                    <i class="fas fa-chart-area fa-fw mr-3"></i
                    ><span>Webiste traffic</span></a
                  >
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link"
                    ><i class="fas fa-cogs fa-fw mr-3"></i><span>Settings</span></a
                  >
                  <ul class="sidenav-collapse">
                    <li class="sidenav-item">
                      <a class="sidenav-link">Profile</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Account</a>
                    </li>
                  </ul>
                </li>
                <li class="sidenav-item">
                  <a class="sidenav-link"
                    ><i class="fas fa-lock fa-fw mr-3"></i><span>Password</span></a
                  >
                  <ul class="sidenav-collapse">
                    <li class="sidenav-item">
                      <a class="sidenav-link">Request password</a>
                    </li>
                    <li class="sidenav-item">
                      <a class="sidenav-link">Reset password</a>
                    </li>
                  </ul>
                </li>
              </ul>
            </div>
            <!-- Sidenav -->

            <!-- Navbar -->
            <nav
              id="main-navbar"
              class="navbar navbar-expand-lg navbar-light bg-white fixed-top"
            >
              <!-- Container wrapper -->
              <div class="container-fluid">
                <!-- Toggler -->
                <button
                  data-toggle="sidenav"
                  data-target="#sidenav-1"
                  class="btn shadow-0 p-0 mr-3 d-block d-xxl-none"
                  aria-controls="#sidenav-1"
                  aria-haspopup="true"
                >
                  <i class="fas fa-bars fa-lg"></i>
                </button>

                <!-- Search form -->
                <form class="d-none d-md-flex input-group w-auto my-auto">
                  <input
                    autocomplete="off"
                    type="search"
                    class="form-control rounded"
                    placeholder='Search (ctrl + "/" to focus)'
                    style="min-width: 225px"
                  />
                  <span class="input-group-text border-0"
                    ><i class="fas fa-search"></i
                  ></span>
                </form>

                <!-- Right links -->
                <ul class="navbar-nav ml-auto d-flex flex-row">
                  <!-- Notification dropdown -->
                  <li class="nav-item dropdown">
                    <a
                      class="nav-link mr-3 mr-lg-0 dropdown-toggle hidden-arrow"
                      href="#"
                      id="navbarDropdownMenuLink"
                      role="button"
                      data-toggle="dropdown"
                      aria-expanded="false"
                    >
                      <i class="fas fa-bell"></i>
                      <span class="badge rounded-pill badge-notification bg-danger"
                        >1</span
                      >
                    </a>
                    <ul
                      class="dropdown-menu dropdown-menu-right"
                      aria-labelledby="navbarDropdownMenuLink"
                    >
                      <li><a class="dropdown-item" href="#">Some news</a></li>
                      <li><a class="dropdown-item" href="#">Another news</a></li>
                      <li>
                        <a class="dropdown-item" href="#">Something else here</a>
                      </li>
                    </ul>
                  </li>

                  <!-- Icon -->
                  <li class="nav-item">
                    <a class="nav-link mr-3 mr-lg-0" href="#">
                      <i class="fas fa-fill-drip"></i>
                    </a>
                  </li>
                  <!-- Icon -->
                  <li class="nav-item mr-3 mr-lg-0">
                    <a class="nav-link" href="#">
                      <i class="fab fa-github"></i>
                    </a>
                  </li>

                  <!-- Icon dropdown -->
                  <li class="nav-item dropdown">
                    <a
                      class="nav-link mr-3 mr-lg-0 dropdown-toggle hidden-arrow"
                      href="#"
                      id="navbarDropdown"
                      role="button"
                      data-toggle="dropdown"
                      aria-expanded="false"
                    >
                      <i class="united kingdom flag m-0"></i>
                    </a>
                    <ul
                      class="dropdown-menu dropdown-menu-right"
                      aria-labelledby="navbarDropdown"
                    >
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="united kingdom flag"></i>English
                          <i class="fa fa-check text-success ml-2"></i
                        ></a>
                      </li>
                      <li><hr class="dropdown-divider" /></li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="poland flag"></i>Polski</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="china flag"></i>中文</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="japan flag"></i>日本語</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="germany flag"></i>Deutsch</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="france flag"></i>Français</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="spain flag"></i>Español</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="russia flag"></i>Русский</a
                        >
                      </li>
                      <li>
                        <a class="dropdown-item" href="#"
                          ><i class="portugal flag"></i>Português</a
                        >
                      </li>
                    </ul>
                  </li>

                  <!-- Avatar -->
                  <li class="nav-item dropdown">
                    <a
                      class="nav-link dropdown-toggle hidden-arrow d-flex align-items-center"
                      href="#"
                      id="navbarDropdownMenuLink"
                      role="button"
                      data-toggle="dropdown"
                      aria-expanded="false"
                    >
                      <img
                        src="https://mdbootstrap.com/img/Photos/Avatars/img (31).jpg"
                        class="rounded-circle"
                        height="22"
                        alt=""
                        loading="lazy"
                      />
                    </a>
                    <ul
                      class="dropdown-menu dropdown-menu-right"
                      aria-labelledby="navbarDropdownMenuLink"
                    >
                      <li><a class="dropdown-item" href="#">My profile</a></li>
                      <li><a class="dropdown-item" href="#">Settings</a></li>
                      <li><a class="dropdown-item" href="#">Logout</a></li>
                    </ul>
                  </li>
                </ul>
              </div>
              <!-- Container wrapper -->
            </nav>
            <!-- Navbar -->
          </header>
          <!--Main Navigation-->
          
          <!--Main layout-->
          <main style="margin-top: 58px">
            <div class="container">

            </div>
          </main>
          <!--Main layout-->
          
          <!--Footer-->
          <footer></footer>
          <!--Footer-->
        

          const sidenav = document.getElementById("sidenav-1");
          const sidenavInstance = mdb.Sidenav.getInstance(sidenav);

          let innerWidth = null;

          const setMode = (e) => {
            // Check necessary for Android devices
            if (window.innerWidth === innerWidth) {
              return;
            }

            innerWidth = window.innerWidth;

            if (window.innerWidth < 1400) {
              sidenavInstance.changeMode("over");
              sidenavInstance.hide();
            } else {
              sidenavInstance.changeMode("side");
              sidenavInstance.show();
            }
          };

          setMode();

          // Event listeners
          window.addEventListener("resize", setMode);
        

          @media (min-width: 1400px) {
            main,
            header,
            #main-navbar {
              padding-left: 240px;
            }
          }
        

Sidenav - API


Usage

Via data attributes

Elements with the sidenav class will be automatically initialized - you can set all available options with data attributes. Toggling the element can also be done without any additional Javascript code - just set data-toggle and data-target attribute on the navigation's toggler.


        <div class="sidenav" id="sidenav" data-color="secondary">
          <!-- ... -->
        </div>

        <button type="button" data-toggle="sidenav" data-target="#sidenav">
          Toggle sidenav
        </button>
      

Via JavaScript

You can access an instance from your Javascript code, by using the getInstance static method of the Sidenav class - it allows making use of all the public methods listed in the Methods section.


        const sidenavInstance = mdb.Sidenav.getInstance(document.getElementById('sidenav'));

        sidenavInstance.update({ color: 'warning'});
      

Via jQuery

Note: By default, MDB does not include jQuery and you have to add it to the project on your own.


        $('#sidenav').sidenav('update', { color: 'warning'})
      

Options

Name Type Default Description
accordion Boolean false Enables accordion behaviour in a navigation container
backdrop Boolean true Adds/removes a backdrop in an over mode
backdropClass String - Adds a custom class to a backdrop
closeOnEsc Boolean true Closes a side drawer on ESC key (only when toggler is visible)
color String primary Changes a color of active/hovered links and categories
content String Selector for a content to which a component will add paddings/margins in push/side modes
expandOnHover Boolean false Expands/collapses slim mode on mouseover / mouseleave
hidden Boolean true Initializes navigation outside a viewport
mode String over Sets position mode - available options: over, side, push
scrollContainer String Selector for a scrollable container inside a side drawer
slim Boolean false Enables a slim mode
slimCollapsed Boolean false Initializes a component in a slim mode
slimWidth Number 70 A component's width in a slim mode (pixels)
position String fixed Sets CSS position - accepted values: fixed, absolute
right Boolean false Initializes sidenav on a right side
transitionDuration Number 300 Sets a length of transitions (in milliseconds)
width Number 70 A component's width (pixels)

Methods

Name Description Example
changeMode Changes a position mode (options: over, side, push) sidenavInstance.changeMode('push')
dispose Removes mdb.Sidenav instance sidenavInstance.dispose()
hide Hides a navigation drawer sidenavInstance.hide()
show Shows a navigation drawer sidenavInstance.show()
toggle Manually toggles a component sidenavInstance.toggle()
toggleSlim Manually toggles a slim state sidenavInstance.toggleSlim()
update(options) Updates a component sidenavInstance.update({ mode: 'side' })

        const sidenav = document.getElementById('mySidenav') 
        const sidenavInstance = new mdb.Sidenav(sidenav)
        sidenavInstance.show()
      

Events

Name Description
show.mdb.sidenav Emitted when a component has been toggled
shown.mdb.sidenav Emitted once a component is shown (after transition)
hide.mdb.sidenav Emitted when a component has been toggled
hidden.mdb.sidenav Emitted once a component is hidden (after transition)
expand.mdb.sidenav Emitted when a slim mode has been toggled
expanded.mdb.sidenav Emitted once a component has expanded from a slim mode (after transition)
collapse.mdb.sidenav Emitted when a slim mode has been toggled
collapsed.mdb.sidenav Emitted once a component has collapsed into a slim mode (after transition)
update.mdb.sidenav Emitted whenever a content's offset should be updated (push/side mode). You can access the suggested values by event.padding and event.margin properties

        const sidenav = document.getElementById('mySidenav') 
        sidenav.addEventListener('update.mdb.sidenav', event => {
          console.log(event.margin, event.padding);
        }
      

Import

MDB UI KIT also works with module bundlers. Use the following code to import this component:


        import { Sidenav } from 'mdb-ui-kit';