npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cerulean-sea-navigation

v1.0.3

Published

A navigation library for websites, inspired by the depths and colors of the sea.

Downloads

3

Readme

Cerulean Sea Navigation

Cerulean Sea Navigation is a lightweight, dependency-free library designed to enhance your website's scrolling and animation experiences. Leveraging the popular smooth-scroll and aos libraries, it offers an easy-to-use interface for smooth scrolling and on-scroll animations with minimal setup.

Features

  • Smooth scrolling to anchor links with customizable speed.
  • On-scroll animations with AOS (Animate On Scroll) for any element, configurable with options such as duration and once-only animations.

Installation

You can install cerulean-sea-navigation via npm:

npm install cerulean-sea-navigation

Or, if you prefer, yarn:

yarn add cerulean-sea-navigation

Usage

First, import cerulean-sea-navigation in your JavaScript module:

import CeruleanSeaNavigation from 'cerulean-sea-navigation';

Then, initialize it:

new CeruleanSeaNavigation();

This sets up both the smooth scroll and AOS functionalities with default settings.

Advanced Configuration

CeruleanSeaNavigation works out of the box with sensible defaults, but both smooth scrolling and AOS can be customized further if needed.

Smooth Scroll

To adjust smooth scroll settings, modify the initSmoothScroll method in CeruleanSeaNavigation:

initSmoothScroll() {
new SmoothScroll('a[href*="#"]', {
speed: 500, // Adjust scrolling speed (in ms)
speedAsDuration: true // Use speed as duration rather than a velocity
});
}

AOS

Similarly, to customize AOS settings, adjust the initAOS method:

initAOS() {
AOS.init({
duration: 1000, // Control animation duration
once: false, // Repeat animations on scroll
});
}

Contributing

We welcome contributions to cerulean-sea-navigation! Whether it's bug reports, feature requests, or contributions to the code, please feel free to reach out or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.