1 Star 1 Fork 0

Jay_Ohhh / anchor-scroll-menu

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

anchor-scroll-menu 👋
Anchor menu with scrolling contents for React

Version downloads License: MIT

🏠 Homepage

Demo & Document

Install

$ npm install anchor-scroll-menu

Snapshot

scroll

Usage

import React from 'react';
import { AnchorMenu } from 'anchor-scroll-menu';

const commonStyle = { height: 300 };
const id = +new Date();
const menuList = [
  {
    name: 'antiquewhite',
    key: `antiquewhite${id}`,
    content: <div style={{ ...commonStyle, backgroundColor: 'antiquewhite' }} />,
  },
  {
    name: 'skyblue',
    key: `skyblue${id}`,
    content: <div style={{ ...commonStyle, backgroundColor: 'skyblue' }} />,
  },
  {
    name: 'pink',
    key: `pink${id}`,
    content: <div style={{ ...commonStyle, backgroundColor: 'pink' }} />,
  },
  {
    name: 'orange',
    key: `orange${id}`,
    content: <div style={{ ...commonStyle, backgroundColor: 'orange' }} />,
  },
  {
    name: 'lightcoral',
    key: `lightcoral${id}`,
    content: <div style={{ ...commonStyle, backgroundColor: 'lightcoral' }} />,
  },
];

export default () => (
  <div style={{ width: '100%', height: 600 }}>
    <AnchorMenu menuList={menuList} />
  </div>
);

API

Name Description Type Default
menuList 菜单数据数组,key 请确保是唯一的,由字母数字组成,且必须以字母开头 { name: string; content: ReactNode; key: string; }[] []
menuStyle menu 区域的 style CSSProperties --
placement menu 区域的位置 "top" | "right" | "bottom" | "left" left
scrollDirection 滚动方向 "vertical" | "horizontal" vertical
region 手动滚动时,滚动内容跟父元素顶部距离的区间, 滚动内容一到达该区间, 对应菜单按钮高亮。如果滚动过快时,菜单没有高亮,不妨将区间增大。 [number, number] [-20, 20]
easing 缓动动画函数 "linear" | "easeInQuad" | "easeOutQuad" | "easeInOutQuad" | "easeInCubic" | "easeOutCubic" | "easeInOutCubic" easeInOutCubic
duration 用多少 ms 完成滚动动画,单位 ms number 300
hideTitle 隐藏内容块的 title boolean false
activeKey 当前激活的 menu 的 key string --
onMenuClick 点击菜单的回调函数 (key: string, index: number, activeKey: string) => void --
onReach 点击菜单滚动到达目的地后的回调函数 (key: string, index: number) => void --

👔 Author

Jay-Ohhh

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Jay-Ohhh.

This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

MIT License Copyright (c) 2021 Jay_Ohhh Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Anchor menu with scrolling contents for React 展开 收起
TypeScript 等 3 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/Jay_Ohhh/anchor-scroll-menu.git
git@gitee.com:Jay_Ohhh/anchor-scroll-menu.git
Jay_Ohhh
anchor-scroll-menu
anchor-scroll-menu
master

搜索帮助