萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery Pagewalkthrough 插件實現新手引導頁:遮罩高亮、步驟配置、工具提示定位完整教程

插件簡介

Pagewalkthrough 是輕量級 jQuery 插件,用於創建分步驟的功能引導遮罩層,幫助新用戶快速了解頁面關鍵功能。支持模態框、工具提示兩種模式,靈活定位,易於定製。

HTML 結構:引導內容容器(隱藏)

<div id="walkthrough-content" style="display:none">
  <div id="walkthrough-1">
    <h3>歡迎來到功能引導演示頁</h3>
    <p>點擊「下一步」了解更多...</p>
  </div>
  <div id="walkthrough-2">這裡是網站 LOGO,點擊直達首頁。</div>
  <div id="walkthrough-3">點擊查看插件使用教程。</div>
  <div id="walkthrough-4">點擊下載源碼。</div>
  <div id="walkthrough-5">頁腳版權信息。</div>
</div>

<!-- 頁面實際功能元素 -->
<div id="logo">LOGO</div>
<h2 class="top_title"><a href="/tutorial">教程鏈接</a></h2>
<a href="/download.zip">下載按鈕</a>
<div id="footer"><p>版權所有</p></div>

JavaScript 初始化與配置

<script src="jquery.min.js"></script>
<script src="jquery.pagewalkthrough.min.js"></script>
<script>
$(function() {
  $('body').pagewalkthrough({
    name: 'intro-tour', // 本地存儲標識,避免重複顯示
    steps: [
      // 步驟 1:模態框居中
      { popup: { content: '#walkthrough-1', type: 'modal' } },

      // 步驟 2:工具提示定位在 #logo 下方
      { wrapper: '#logo', popup: { content: '#walkthrough-2', type: 'tooltip', position: 'bottom' } },

      // 步驟 3:工具提示定位在鏈接下方
      { wrapper: 'h2.top_title a', popup: { content: '#walkthrough-3', type: 'tooltip', position: 'bottom' } },

      // 步驟 4:工具提示定位在下載鏈接右側
      { wrapper: 'a[href="/download.zip"]', popup: { content: '#walkthrough-4', type: 'tooltip', position: 'right' } },

      // 步驟 5:工具提示定位在頁腳上方
      { wrapper: '#footer p', popup: { content: '#walkthrough-5', type: 'tooltip', position: 'top' } }
    ],
    // 全局默認配置(可被步驟覆蓋)
    popup: { offsetHorizontal: 10, offsetVertical: 10, width: 300 }
  });

  // 手動啟動(或配置 autoShow: true 自動顯示)
  $('body').pagewalkthrough('show');
});
</script>

關鍵配置詳解

選項說明
name本地存儲鍵名,用戶完成引導後寫入,下次不再自動顯示
steps步驟數組,每步包含 wrapper(目標元素選擇器) 和 popup(內容/類型/位置)
wrapper目標元素選擇器,tooltip 模式下必填;modal 模式可省略
popup.content內容選擇器(指向隱藏容器內的 div)或 HTML 字符串
popup.type'modal' 居中遮罩 / 'tooltip' 定位提示
popup.positiontooltip 位置:top/right/bottom/left
popup.offsetHorizontal/Vertical微調偏移像素

CSS 定製(引用插件默認樣式後覆蓋)

<link rel="stylesheet" href="css/jquery.pagewalkthrough.css">
<style>
/* 隱藏內容容器 */
#walkthrough-content { display:none; }
/* 自定義按鈕樣式 */
.walkthrough-button { background:#64991e; color:#fff; border:none; padding:8px 16px; border-radius:4px; }
.walkthrough-button:hover { background:#538018; }
/* 遮罩層半透明度 */
.walkthrough-overlay { background:rgba(0,0,0,0.7); }
/* 箭頭方向調整 */
.walkthrough-tooltip.arrow-bottom:after { border-top-color:#fff; }
</style>

進階用法

  • 動態步驟:根據用戶角色/權限動態構建 `steps` 數組。
  • 事件鉤子:`onShow`、`onHide`、`onNext`、`onPrev`、`onComplete` 回調執行統計上報、解鎖功能。
  • 重置引導:`localStorage.removeItem('intro-tour')` 或插件方法 `$.pagewalkthrough('reset')`。
  • 移動端適配:響應式 CSS 調整 tooltip 寬度、位置,避免遮擋關鍵操作區。

現代替代方案

  • Intro.js:更流行、無 jQuery 依賴、支持鍵盤導航、進度條、RTL。
  • Shepherd.js:功能豐富、模塊化、支持 Vue/React/Angular 綁定。
  • Driver.js:輕量、原生 JS、高亮動畫流暢。
copyright © 萬盛學電腦網 all rights reserved