# scroll-nav

**Repository Path**: lwj1426282929/scroll-nav

## Basic Information

- **Project Name**: scroll-nav
- **Description**: 滚动导航插件
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-03-01
- **Last Updated**: 2024-06-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lwj-scroll-nav

#### 介绍

滚动导航插件

#### 安装教程

##### npm

```bash
npm i lwj-scroll-nav -D
```

##### browser

```js
<script src="https://unpkg.com/browse/lwj-scroll-nav@0.0.2/dist/index.umd.js"></script>
```

#### 使用说明

```js
import ScrollNav from "lwj-scroll-nav";

this.scrollNav = new ScrollNav({
  scrollContainer: ".scroll-container",
  scrollItem: ".scroll-container .scroll-item",
  navItem: ".nav .nav-item",
  activeNavItemClass: "active",
  offset: 0,
});
```

##### 配置项

| 参数               | 类型   | 是否必须 | 可选值 | 默认值                         | 说明                     |
| ------------------ | ------ | -------- | ------ | ------------------------------ | ------------------------ |
| scrollContainer    | string | 否       | -      | .scroll-container              | 滚动容器                 |
| scrollItem         | string | 否       | -      | .scroll-container .scroll-item | 滚动项                   |
| navItem            | string | 否       | -      | .nav .nav-item                 | 导航项                   |
| activeNavItemClass | string | 否       | -      | active                         | 导航项激活时的 className |
| indexKey           | string | 否       | -      | -                              | 导航索引                 |
| offset             | number | 否       | -      | 0                              | 导滚动偏移距离           |