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

svg-gear-generator

v1.1.5

Published

Generate an SVG of a gear!

Downloads

11

Readme

svg-gear-generator

npm shield

This library allows you to generate an SVG of a simple gear. This does NOT generate a technically accurate gear, with things like correct curved involutes and undercuts, etc. Useful for custom settings icons, (and generating stars!).

Installation

yarn add svg-gear-generator

or

npm install svg-gear-generator --save

Usage

There are three possible uses:

  1. generateGear(args): This generates a d attribute for use with <path>. Used internally by the following components.
  2. <Gear> component: For use with React. Returns a <path> element.
  3. <GearWithAxle> component: For use with React, same as <Gear> but also includes a circle for the axle.

Arguments for the generateGear function and custom props for <Gear> and <GearWithAxle> are the same:

  • radii: { outer: number; inner: number }: Specify the outer and inner radiuses of the gear (addendum and dedendum circle radiuses)
  • numTeeth: number: Number of gear teeth.
  • toothThicknessPercent: number: For each tooth, how much of it is the flat part (see examples). Optional, defaults to 0.5

The <Gear> component additionally takes any props that <path> does. The <GearWithAxle> takes additionally:

  • axleRadius: number: Radius of the axle.
  • axleProps: React.SVGAttributes<SVGPathElement>: Any additional props to be passed to the <circle> element. If undefined, will copy any props specified on the <GearWithAxle> component onto the <circle> element.

Examples

Gear with 9 teeth and axle.

<svg xmlns="http://www.w3.org/2000/svg" viewBox="-2 -2 4 4">
    <GearWithAxle
        axleRadius={0.6}
        numTeeth={9}
        radii={{inner: 1.0, outer: 0.8}}
        toothThicknessPercent={0.5}
        fill="none"
        stroke="black"
        strokeWidth={0.05}
        strokeLinejoin="round"
    />
</svg>

Gear with 9 teeth

Gear with 13 teeth.

<svg xmlns="http://www.w3.org/2000/svg" viewBox="-2 -2 4 4">
    <Gear
        numTeeth={13}
        radii={{inner: 1.0, outer: 0.85}}
        toothThicknessPercent={0.5}
        fill="none"
        stroke="black"
        strokeWidth={0.05}
        strokeLinejoin="round"
    />
</svg>

Gear with 13 teeth

Starbust

<svg xmlns="http://www.w3.org/2000/svg" viewBox="-2 -2 4 4">
    <Gear
        numTeeth={13}
        radii={{inner: 1.0, outer: 0.7}}
        toothThicknessPercent={1.0}
        fill="none"
        stroke="black"
        strokeWidth={0.05}
        strokeLinejoin="round"
    />
</svg>

Starburst

Star

<svg xmlns="http://www.w3.org/2000/svg" viewBox="-2 -2 4 4">
    <Gear
        numTeeth={5}
        radii={{inner: 1.0, outer: 0.4}}
        toothThicknessPercent={0.0}
        fill="none"
        stroke="black"
        strokeWidth={0.05}
        strokeLinejoin="miter"
    />
</svg>

Star

License

MIT

Like this library? Support my hobby!

PayPal donation link