一页式网站导航jQuery插件技术文档

2024-12-20 14:13:44作者：明树来

jQuery-One-Page-Nav

Smooth scrolling and smart navigation when user scrolls on one-page sites.

项目地址：https://gitcode.com/gh_mirrors/jq/jQuery-One-Page-Nav

1. 安装指南

在开始使用本插件之前，请确保您已经具备以下条件：

HTML页面上已经包含了需要导航的各个部分。
已经通过<link>标签或者通过脚本引入了jQuery库。

接下来，通过以下步骤安装本插件：

下载插件文件或者通过npm等包管理工具安装。
在HTML页面的<head>标签内或者页面底部引入下载的插件文件。

<script src="path/to/jquery-one-page-nav.js"></script>

确保这个脚本标签位于jQuery库引入标签之后。

2. 使用说明

本插件适用于一页式网站，能够实现点击导航时的平滑滚动效果，并且会自动选中当前滚动到的导航项。

以下是一个简单的使用示例：

首先，确保您的HTML结构如下所示：

<ul id="nav">
    <li class="current"><a href="#section-1">Section 1</a></li>
    <li><a href="#section-2">Section 2</a></li>
    <li><a href="#section-3">Section 3</a></li>
</ul>

<div id="section-1">
    <strong>Section 1</strong>
    <p>...</p>
</div>

<div id="section-2">
    <strong>Section 2</strong>
    <p>...</p>
</div>

<div id="section-3">
    <strong>Section 3</strong>
    <p>...</p>
</div>

然后，在JavaScript中初始化插件：

$('#nav').onePageNav({
    currentClass: 'current',
    changeHash: false,
    scrollSpeed: 750,
    scrollThreshold: 0.5,
    filter: '',
    easing: 'swing',
    begin: function() {
        // 动画开始时触发
    },
    end: function() {
        // 动画结束时触发
    },
    scrollChange: function($currentListItem) {
        // 当进入一个部分时触发，并传递当前部分的列表项
    }
});

3. 项目API使用文档

以下是插件支持的选项及其描述：

currentClass: 当前的导航项将应用此class，默认为'current'。
changeHash: 是否在点击导航项时更改URL的hash部分，默认为false。
scrollSpeed: 滚动速度，单位毫秒，默认为750。
scrollThreshold: 滚动阈值，用于决定何时触发scrollChange回调，默认为0.5。
filter: 过滤器选择器，用于排除不需要的导航项，默认为空字符串。
easing: 动画效果，默认为'swing'。
begin: 动画开始时的回调函数。
end: 动画结束时的回调函数。
scrollChange: 当滚动到新部分时触发的回调函数。

4. 项目安装方式

除了手动下载插件文件并引入到项目中，您还可以通过以下方式安装：

通过npm：

npm install jquery-one-page-nav

通过yarn：

yarn add jquery-one-page-nav

安装后，您可以使用模块化的方式在项目中引入该插件。

jQuery-One-Page-Nav

Smooth scrolling and smart navigation when user scrolls on one-page sites.

项目地址：https://gitcode.com/gh_mirrors/jq/jQuery-One-Page-Nav

登录后查看全文

项目优选

收起

OpenHarmony documentation | OpenHarmony开发者文档

deepin linux kernel

ohos_react_native

React Native鸿蒙化仓库

Ascend Extension for PyTorch

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

flutter_flutter

一个用于服务器应用开发的综合工具库。 - 零配置文件 - 环境变量和命令行参数配置 - 约定优于配置 - 深刻利用仓颉语言特性 - 只需要开发动态链接库，fboot负责加载、初始化并运行。

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

cangjie_compiler

仓颉编译器源码及 cjdb 调试工具。

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！