使用JavaScript实现侧边栏切换功能

聖光之護
发布: 2025-10-27 12:15:01
原创
772人浏览过

使用JavaScript实现侧边栏切换功能

本文将详细指导如何创建一个按钮,通过javascript代码来控制网页侧边栏的显示与隐藏。我们将通过一个具体的htmljavascript示例,展示如何获取dom元素、绑定事件监听器,并动态修改侧边栏的css display属性,从而实现流畅的用户交互体验。文章还将探讨优化方案,如使用css类进行切换以支持动画效果。

引言

在现代网页设计中,侧边栏(Sidebar)常用于提供导航菜单、工具集或辅助信息,对于优化用户体验和有效利用屏幕空间至关重要。实现侧边栏的显示与隐藏功能,即“切换”功能,是前端开发中的一个常见需求。通过一个简单的按钮,用户可以根据需要展开或收起侧边栏,从而在内容区域和导航之间灵活切换。本文将介绍如何使用纯JavaScript实现这一功能,并提供一个完整的示例。

HTML结构准备

首先,我们需要定义侧边栏和控制其显示/隐藏的按钮的HTML结构。在这个示例中,我们使用Bootstrap进行基本的布局。

<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">

<header class="header row ">
  <div class="d-flex justify-content-between">
    <div id="logo" class="pb-2 ps-2 pe-0 col-2">
      <img class="float-start py-2 ps-2 pe-2" src="assets/img/unknown.png">
      <!-- 侧边栏切换按钮,通过id="menu-toggle"进行标识 -->
      <a href="#" class="sidebar-toggler flex-shrink-0" id="menu-toggle">
        <i class="fa-solid fa-angle-left py-4 pe-2"></i>
      </a>
    </div>
  </div>
</header>
<div class="body row ">
  <!-- 侧边栏容器,通过id="sidebar"进行标识 -->
  <div class="sidebar col-2 " id="sidebar">
    <!--sidebar start-->
    <div class="navbar-nav w-100">
      <div class="nav-item dropdown">
        <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown"><i class="fa fa-laptop me-2"></i>Admin</a>
        <div class="dropdown-menu bg-transparent border-0">
          <a href="#" class="dropdown-item">A</a>
          <a href="#" class="dropdown-item">B</a>
          <a href="#" class="dropdown-item">C</a>
        </div>
      </div>
      <a href="#" class="nav-item nav-link"><i class="fa fa-th me-2"></i>Cập nhật PO</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-keyboard me-2"></i>Phân loại PO</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-chart-bar me-2"></i>Ước tính rebate</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Cập nhật rebate</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Báo cáo</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Tra cứu thông tin</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Hướng dẫn sử dụng</a>
    </div>
    <!--sidebar end-->
  </div>
  <div class="content col-10"> Content
  </div>
</div>
<script src="https://kit.fontawesome.com/60bf89e922.js" crossorigin="anonymous"></script>
登录后复制

关键点:

  • 切换按钮: <a id="menu-toggle" ...> 按钮被赋予了唯一的 id="menu-toggle",这是JavaScript选择该元素的关键。
  • 侧边栏容器: <div id="sidebar" ...> 侧边栏容器被赋予了唯一的 id="sidebar",以便JavaScript能够准确地操作它。
  • Bootstrap布局: col-2 和 col-10 类用于定义侧边栏和内容区域的宽度比例。

JavaScript实现侧边栏切换逻辑

核心逻辑是通过JavaScript监听按钮的点击事件,然后根据侧边栏当前的显示状态来切换其 display 样式属性。

立即学习Java免费学习笔记(深入)”;

<script>
  document.querySelector('#menu-toggle').onclick = e => {
    // 获取侧边栏元素
    var sidebar = document.querySelector('#sidebar');
    // 检查侧边栏当前的display样式
    if (sidebar.style.display !== 'none') {
      // 如果不是隐藏状态,则将其设置为隐藏
      sidebar.style.display = 'none';
    } else {
      // 如果是隐藏状态,则将其设置为显示
      sidebar.style.display = 'block';
    }
  };
</script>
登录后复制

代码解析:

  1. document.querySelector('#menu-toggle'):通过ID选择器获取到侧边栏切换按钮元素。
  2. .onclick = e => { ... }:为按钮的 click 事件绑定一个事件处理函数。当按钮被点击时,该函数会被执行。
  3. var sidebar = document.querySelector('#sidebar');:在事件处理函数内部,获取到侧边栏元素。
  4. if (sidebar.style.display !== 'none'):判断侧边栏当前的 display 样式是否为 'none'。style.display 直接访问元素的内联样式。
  5. sidebar.style.display = 'none'; 或 sidebar.style.display = 'block';:根据判断结果,将侧边栏的 display 属性在 'none' 和 'block' 之间切换,从而实现隐藏和显示。

完整示例

将HTML结构和JavaScript代码整合,形成一个完整的可运行示例。请将以下代码保存为.html文件并在浏览器中打开。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>可切换侧边栏示例</title>
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
    <style>
        /* 确保侧边栏初始状态可见或根据需求设置 */
        .sidebar {
            background-color: #f8f9fa;
            border-right: 1px solid #dee2e6;
            min-height: calc(100vh - 56px); /* 假设header高56px */
        }
        .content {
            padding: 20px;
        }
    </style>
</head>
<body>

<header class="header row ">
  <div class="d-flex justify-content-between">
    <div id="logo" class="pb-2 ps-2 pe-0 col-2">
      <img class="float-start py-2 ps-2 pe-2" src="assets/img/unknown.png" alt="Logo">
      <a href="#" class="sidebar-toggler flex-shrink-0" id="menu-toggle">
        <i class="fa-solid fa-angle-left py-4 pe-2"></i>
      </a>
    </div>
  </div>
</header>
<div class="body row ">
  <div class="sidebar col-2 " id="sidebar">
    <!--sidebar start-->
    <div class="navbar-nav w-100">
      <div class="nav-item dropdown">
        <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown"><i class="fa fa-laptop me-2"></i>Admin</a>
        <div class="dropdown-menu bg-transparent border-0">
          <a href="#" class="dropdown-item">A</a>
          <a href="#" class="dropdown-item">B</a>
          <a href="#" class="dropdown-item">C</a>
        </div>
      </div>
      <a href="#" class="nav-item nav-link"><i class="fa fa-th me-2"></i>Cập nhật PO</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-keyboard me-2"></i>Phân loại PO</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-chart-bar me-2"></i>Ước tính rebate</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Cập nhật rebate</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Báo cáo</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Tra cứu thông tin</a>
      <a href="#" class="nav-item nav-link"><i class="fa fa-tachometer-alt me-2"></i>Hướng dẫn sử dụng</a>
    </div>
    <!--sidebar end-->
  </div>
  <div class="content col-10"> Content
  </div>
</div>

<script src="https://kit.fontawesome.com/60bf89e922.js" crossorigin="anonymous"></script>
<script>
  // 确保DOM加载完成后再执行JavaScript
  document.addEventListener('DOMContentLoaded', function() {
    document.querySelector('#menu-toggle').onclick = e => {
      var sidebar = document.querySelector('#sidebar');
      if (sidebar.style.display !== 'none') {
        sidebar.style.display = 'none';
      } else {
        sidebar.style.display = 'block';
      }
    };
  });
</script>

</body>
</html>
登录后复制

优化与注意事项

虽然上述方法能够实现侧边栏的切换,但在实际开发中,有更推荐的优化方式来提升代码的可维护性、可扩展性和用户体验。

1. 使用CSS类进行切换 (推荐)

直接修改元素的 style.display 属性是一种快速实现方式,但它将样式逻辑硬编码到JavaScript中,不利于分离关注点。更推荐的做法是定义一个CSS类来控制侧边栏的隐藏状态,然后通过JavaScript添加或移除这个类。

ViiTor实时翻译
ViiTor实时翻译

AI实时多语言翻译专家!强大的语音识别、AR翻译功能。

ViiTor实时翻译 116
查看详情 ViiTor实时翻译

CSS示例:

/* 默认侧边栏样式 */
.sidebar {
    /* ... 其他样式 ... */
    transition: all 0.3s ease-in-out; /* 为平滑过渡添加动画 */
}

/* 隐藏状态的侧边栏样式 */
.sidebar.hidden {
    display: none;
    /* 或者使用 transform 实现更平滑的动画效果 */
    /* transform: translateX(-100%); */
    /* width: 0; opacity: 0; */
}

/* 针对 transform 隐藏的布局调整 */
.body.collapsed .content {
    margin-left: 0; /* 如果侧边栏完全收起,内容区占据全部宽度 */
    width: 100%;
}
登录后复制

JavaScript示例 (使用 classList.toggle):

document.addEventListener('DOMContentLoaded', function() {
  const menuToggle = document.querySelector('#menu-toggle');
  const sidebar = document.querySelector('#sidebar');
  const body = document.querySelector('.body'); // 如果需要调整body的布局

  menuToggle.onclick = e => {
    sidebar.classList.toggle('hidden'); // 切换 'hidden' 类
    // 如果需要联动调整内容区布局,可以切换body的类
    // body.classList.toggle('collapsed');
  };
});
登录后复制

这种方法的好处是:

  • 样式与行为分离: CSS负责样式,JavaScript负责行为。
  • 易于维护: 隐藏/显示逻辑集中在CSS中。
  • 支持动画: 结合CSS transition 属性,可以轻松实现侧边栏展开和收起的平滑动画效果,而直接修改 display 属性通常会导致瞬间切换,没有过渡效果。

2. DOM加载时机

确保JavaScript代码在HTML元素加载完成后执行。将 <script> 标签放在 </body> 结束标签之前,或者使用 DOMContentLoaded 事件监听器,都是确保这一点的有效方法。在上述完整示例中,我们已经采用了 DOMContentLoaded。

3. 可访问性 (ARIA)

为了提升屏幕阅读器用户的体验,建议为切换按钮添加ARIA属性,例如 aria-expanded。

<a href="#" class="sidebar-toggler flex-shrink-0" id="menu-toggle" aria-expanded="true">
  <i class="fa-solid fa-angle-left py-4 pe-2"></i>
</a>
登录后复制

在JavaScript中,根据侧边栏的显示状态更新 aria-expanded 的值:

document.addEventListener('DOMContentLoaded', function() {
  const menuToggle = document.querySelector('#menu-toggle');
  const sidebar = document.querySelector('#sidebar');

  // 初始状态设置
  let isSidebarVisible = true; // 假设侧边栏默认可见
  menuToggle.setAttribute('aria-expanded', isSidebarVisible);

  menuToggle.onclick = e => {
    sidebar.classList.toggle('hidden');
    isSidebarVisible = !isSidebarVisible;
    menuToggle.setAttribute('aria-expanded', isSidebarVisible);
  };
});
登录后复制

当侧边栏可见时,aria-expanded 应为 true;当侧边栏隐藏时,应为 false。

总结

通过本文,我们学习了如何使用纯JavaScript创建一个简单的按钮来切换侧边栏的显示与隐藏。从直接修改 display 属性到更推荐的通过CSS类实现切换,我们了解了不同的实现方式及其优缺点。在实际项目中,采用CSS类结合 transition 属性的方法,能够带来更佳的用户体验和代码可维护性。同时,不应忽视DOM加载时机和可访问性等重要考量,以构建健壮且用户友好的Web界面。

以上就是使用JavaScript实现侧边栏切换功能的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号