https://github.com/athm-fe/floornav
https://github.com/athm-fe/floornav
jquery-plugin scrollspy
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/athm-fe/floornav
- Owner: athm-fe
- License: mit
- Created: 2018-01-28T13:45:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-28T03:05:22.000Z (over 7 years ago)
- Last Synced: 2025-02-11T23:02:36.643Z (over 1 year ago)
- Topics: jquery-plugin, scrollspy
- Language: JavaScript
- Homepage: https://athm-fe.github.io/floornav/
- Size: 21.5 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Floornav
## HTML 结构
```html
占位
这是1楼
这是2楼
这是3楼
这是4楼
这是5楼
这是6楼
占位
```
## Usage
```javascript
$('#floornav').floornav(options);
```
## Options
参数可以通过 data attributes 或者 JavaScript 两种方式来配置.
Name | Type | Default | Description
---- | ---- | ------- | -----------
container | object | window | 滚动容器.
base | string | 'center' | 计算区块位置的参照线, 值可以为 `'center'`, `'top'`, `'bottom'`.
threshold | number | 0 | 距离参照线多远即认为区块出现.
activeClass | string | active | 导航器当前项样式
showClass | string | show | 导航器显示时添加的样式
scrollOffset | number | 0 | 滚动差值, 假如页面有吸顶元素, 点击导航滚动到对应楼层时会被遮挡, 所以提供了这个参数来解决问题.
## Methods
### `.floornav(options)`
初始化.
```javascript
$('#floornav').floornav({
threshold: 100
});
```
### `.floornav('check')`
触发一次手动检查.
```javascript
$('#floornav').floornav('check');
```
### `.floornav('update')`
当导航或者楼层有变化时，需要手动更新
```javascript
$('#floornav').floornav('update');
```
## Event
None.
# End
Thanks to [Bootstrap](http://getbootstrap.com/)