1.2.5 • Published 3 months ago

single-page-scrolling-navigation v1.2.5

Weekly downloads
-
License
ISC
Repository
github
Last release
3 months ago

CMO Single page scrolling navigation

Small library to handle scroll navigation on one page websites

Install

npm install single-page-scrolling-navigation
import { singlePageNavigation } from "single-page-scrolling-navigation";

Setting

ReactJS:

useEffect(() => {
  singlePageNavigation({
    selector: ".nav",
    childSelector: ".nav li a",
    time: 2000,
    easing: "easeInOutQuad",
    cb: () => console.log("animation finished"),
  });
}, []);
<nav className="nav">
  <ul>
    <li>
      <a href="#about">About</a>
    </li>
    <li>
      <a href="#services">Services</a>
    </li>
    <li>
      <a href="#work">Work</a>
    </li>
    <li>
      <a href="#contact">Contact</a>
    </li>
  </ul>
</nav>

HTML and VanillaJs:

cmoHashNavigation({
  selector: ".nav",
  childSelector: ".nav li a",
  time: 2000,
  easing: "easeInOutQuad",
  cb: () => console.log("animation finished"),
});
<nav class="nav">
  <ul>
    <li>
      <a href="#about">About</a>
    </li>
    <li>
      <a href="#services">Services</a>
    </li>
    <li>
      <a href="#work">Work</a>
    </li>
    <li>
      <a href="#contact">Contact</a>
    </li>
  </ul>
</nav>

Options

OptionTypeDefaultDescription
selectorstringnullthe selector, it could be a class, id, or tagname
childSelectorstringnullthe child selector, it could be a class, id, or tagname
timeintegernullthe animation duration
cbfunctionnullcallback to execute when animation finish
easingstringnullcould be one of these easeInQuad, easeOutQuad, easeInOutQuad, easeInCubic, easeOutCubic, easeInOutCubic, easeInQuart, easeOutQuart, aseInOutQuart, easeInQuint, easeOutQuint, easeInOutQuint.
1.2.5

3 months ago

1.2.4

3 months ago

1.2.0

3 months ago

1.2.3

3 months ago

1.2.2

3 months ago

1.2.1

3 months ago

1.0.1

12 months ago

1.0.0

12 months ago