Skip to content

An aesthetic and customizable circular visual component for React.

License

Notifications You must be signed in to change notification settings

suyalcinkaya/gauge

Repository files navigation

screenshot

Gauge @suyalcinkaya/gauge minzip package size @suyalcinkaya/gauge package version @suyalcinkaya/gauge NPM Downloads @suyalcinkaya/gauge GitHub License

Gauge is an aesthetic and customizable circular visual component for React.

Examples and playground: https://gauge.onur.dev

Documentation

Find the full API reference in the documentation.

Install

pnpm install @suyalcinkaya/gauge

Use

import { Gauge } from '@suyalcinkaya/gauge'

export function Component(): JSX.Element {
  return <Gauge value={23} />
}

Development

Installation

The Gauge repository uses pnpm Workspaces and Turborepo. To install dependencies, run pnpm install in the project root directory.

pnpm install

Build Gauge

cd packages/gauge
pnpm build

Watch mode: pnpm dev

Development

You can also debug it with the website app locally. For instance; to start apps/website locally, run the following command in the project root directory.

pnpm dev

Check localhost:3000 to see the website app.

Inspiration & Credits

Inspired by Geist Design System from the Vercel team and by geist-gauge from Ajay.