Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 1.72 KB

README.md

File metadata and controls

59 lines (44 loc) · 1.72 KB

React Steelseries

Steelseries Gauges v2 web components wrapped up for react + ts.

View the Storybook

Get Started

Install the dependency using the package manager of your choice

npm i react-steelseries
yarn add react-steelseries
pnpn add react-steelseries

Import the library

// es6/TS
import Steelseries from "react-steelseries";
// umd
const Steelseries = require("react-steelseries");

Example usage:

import Steelseries, { ColorDef } from "react-steelseries";

function App() {
  return <Steelseries.Altimeter value={75} pointerColor={ColorDef.Blue} />;
}

TODO

Web Component Types Component Stories
Altimeter ✔️ ✔️ ✔️
Battery ✔️ ✔️ ✔️
Compass ✔️ ✔️ 🚧
Horizon ✔️ ✔️ 🚧
Level ✔️ ✔️
LightBulb ✔️ ✔️ 🚧
LightLed ✔️ ✔️ 🚧
Odometer ✔️ ✔️
StopWatch ✔️ ✔️
TrafficLight ✔️ ✔️
WindDirection ✔️ ✔️