Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 5.69 KB

README.md

File metadata and controls

131 lines (100 loc) · 5.69 KB
Raw

@gofynd/nitrozen-react

npm version

A React component library inspired from Nitrozen design system

🤔 Getting started

To install @gofynd/nitrozen-react in your project, you will need to run the following command using npm:

npm install -S @gofynd/nitrozen-react

If you prefer Yarn, use the following command instead:

yarn add @gofynd/nitrozen-react
  • Nitrozen component library can be consumed by all React / React with Typescript projects.

Usage

The @gofynd/nitrozen-react package provides components and icons for the Nitrozen Design System.

To use a component, you can import it directly from the package:

import { Button } from "@gofynd/nitrozen-react";

function MyComponent() {
  return <Button rounded>Button</Button>;
}

Example:

button

🚨 Note:

The library uses default font size as 10px. Hence if you are planning to use 10px as base font size, you need to add the same to your code as well.

html,
body {
  font-size: 10px;
}

If you wish to use any other base font-size apart from 10px, you need to add these following:

:root {
  --BaseFontSize: <your font size>; /* number as integer without unit */
}

html,
body {
  font-size: <your font size>; /* number with unit */
}

🔥 Components List:

For a full list of components available & it's detailed documentation, checkout our Storybook.

🏆 Contributors

📖 API Documentation

If you're looking for @gofynd/nitrozen-react API documentation, check out:

📝 License

Licensed under the Apache 2.0 License