@forward-protocol/uikit

About

This package provides not only all core UI components, but also scss variables and mixins.

Table of contents

• Installation
• Example usage

Installation

with npm

  npm install @forward-protocol/uikit

with yarn

  yarn add @forward-protocol/uikit

Example usage

Using components

import { Avatar } from '@forward-protocol/uikit';

// Import styles
import '@forward-protocol/uikit/assets/styles/index.css';

// Then use it as a normal React component
<Avatar variant="default" size="XL" />;

Using scss variables and mixins in scss files

@import '~@forward-protocol/uikit/assets/styles/_colors.scss';