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

react-slips-hook

v0.7.0

Published

Display and layer pages as slips in Gatsby

Downloads

10

Readme

react-slips-hook

Treats pages as slips in Gatsby, allowing multiple pages to slip over and under each other in the viewport.

Incidentally "zettel" as in zettelkasten can refer to slips of paper.

Installation

npm install react-slips-hook

Usage

In your layout component:

import React, { useEffect, useRef, useCallback } from "react";
import Page from "../components/Page";
import {
  useSlipsProvider,
  LinkToSlip,
  useSlip,
  PageIndexProvider,
  SlipsProvider,
} from "react-slips-hook";

const PageContainer = ({ children, slug }) => {
  const [, { overlay, obstructed, highlighted }, i] = useSlip();

  return (
    <div
      className={`page-container ${overlay ? "page-container-overlay" : ""} ${
        obstructed ? "page-container-obstructed" : ""
      }  ${highlighted ? "page-container-highlighted" : ""}`}
      style={{ left: 40 * i, right: -585 }}
    >
      <div className="page-content">{children}</div>
      <LinkToSlip to={slug} className="obstructed-label">
        {slug}
      </LinkToSlip>
    </div>
  );
};

// A wrapper component to render the content of layered slips
const SlipWrapper = ({ children, slug, i }) => (
  <PageIndexProvider value={i}>
    <PageContainer slug={slug}>{children}</PageContainer>
  </PageIndexProvider>
);

const SlipLayout = ({ data, location, slug }) => {
  // Use this callback to update what you want to stack.
  // `pageQuery` will be similar to the data prop you get in a Page component.
  // You can return `null` to filter out the page
  const processPageQuery = useCallback((pageQuery) => pageQuery, []);

  const [state, scrollContainer] = useSlipNotesProvider({
    firstPage: { data, slug },
    location,
    processPageQuery,
    pageWidth: 625,
  });

  return (
    <div className="slip-layout">
      <div className="page-columns-scrolling-container" ref={scrollContainer}>
        <div
          className="page-columns-container"
          style={{ width: 625 * (state.slips.length + 1) }}
        >
          <SlipsProvider value={state}>
            {/* Render the layered slips */}
            {state.slips.map((page, i) => (
              <SlipWrapper i={i} key={page.slug} slug={page.slug}>
                <Page {...page} />
              </SlipWrapper>
            ))}
          </SlipsProvider>
        </div>
      </div>
    </div>
  );
};

export default SlipLayout;

Somewhere in your slip, you can use

import {
  useSlips,
  useSlip,
  LinkToSlip,
} from "react-slips-hook";

const Component = () => {
  const [
    slips,
    slipStates,
    hookedNavigateToSlip,
    highlightSlip,
  ] = useSlips();

  const [
    currentPage,
    currentPageState,
    pageIndex,
    navigateToSlip,
    highlightSlip,
  ] = useSlip();

  return null;
};

const AnotherComponent = () => {
  return (
    <LinkToSlip to={"/slips"}>
      Magic link that will stack a page
    </LinkToSlip>
  );
};