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 🙏

© 2025 – Pkg Stats / Ryan Hefner

react-svg-guides

v0.1.1

Published

Guides implementation for SVG elements in React

Downloads

77

Readme

react-svg-guides

This library provides a set of React hooks and components to implement a concept of guides in SVG.

Explore demos package for a glimpse of what this library can help with.

Types

A guide is encapsulating a numeric value. It is implemented as a function that can be called with a value to update it, or without a value to read it.

export type Guide = {
  (): number;
  (v: number): void;

  id: string;
  name: string;
};

A guides attachment lists guides that are attached to an element. To attach several guides to one coordinate, use more property to chain another GuidesAttachment.

export type GuidesAttachment = {
  top?: Guide;
  verticalCenter?: Guide;
  bottom?: Guide;
  left?: Guide;
  horizontalCenter?: Guide;
  right?: Guide;
  more?: GuidesAttachment;
};

Hooks

Guide

A single guide can be obtained by calling useGuide hook:

declare const useGuide: (defaultValue?: number) => Guide;

const guide = useGuide(0); // optionally set initial value

const moveThings = useCallback(() => {
  guide(100); // update value
}, []);

console.log(guide()); // read value

A designated way to use guide is to attach it via useRefWithGuidesAttached hook or, when used on SVG or HTML components, via guidesAttachment. Attached guide is updated when element's corresponding coordinate is changed.

Named guide

While basic guide is replaceable with e.g. useState, named guide has its name set to a variable name it is assigned to.

Named guides are obtained by calling useGuides hook with a common initial value:

declare const useGuides: (defaultValue?: number) => {
  [key: string]: Guide;
};

const {
  rightGuide,
  bottomGuide,
  guideWithAFancyName,
} = useGuides(0); // optionally set initial value

Components

HTML

declare function HTML({ children, guidesAttachment, ...rest }: {
    guidesAttachment?: GuidesAttachment;
} & SVGAttributes<SVGForeignObjectElement>): JSX.Element;

HTML element has similar API with guidesAttachment prop. Instead of attaching to actual foreignObject container, it attaches to the div element inside allowing to measure its coordinates.