Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@groww-tech/mint-css) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mint CSS

A CSS library that provides classes, tokens, variables, fonts and other essential stylings governed under MINT design system, used by Groww

Installation
Usage
Features
Folder structure
License

Installation

npm install @groww-tech/mint-css

Usage

First, import the package in the root document of your project.

import '@groww-tech/mint-css/dist/index.css';

The dist/index.css is complied and minfied version of the CSS library which will serve all the tokens/classes which can be used in your project.

Features

What are Tokens?

Tokens are abstract entity which denotes symantic meaning and store values. When you use contentAccent, you’re using a colour token which contains #00B386 as its value, same is applicable to typography.

There are two categories through which we will be exposing various semantic tokens. The tokens are further categorized based on visual emphasis and hierarchy of the UI elements.

Typography tokens

GrowwSans and NotoSans font families will get downloaded once you install and import the library into your project. These are the tokens can be used -
- Body
- Display
- Heading
- Button
e.g. The token bodyRegular12 says that, it can be used in body with regular font weight which have font size of 12pts.
```
.bodyRegular12 {
    font-size: var(--font-size-12);
    font-weight: var(--font-weight-regular);
    line-height: 1.5;
}
```
<div className="bodyRegular12">Some content</div>
Color tokens

Again, the color tokens are further classified into different categories and can be used in different styles depending on the UI elements
- Background
- Content
- Border
e.g. We have a token called contentPrimary which refers to the most important and essential information within a piece of content.
```
.contentPrimary {
    color: var(--gray900);
}
```
<div className="contentPrimary">Some content</div>

Folder structure

└── mint-css/
    ├── dist/
    │   ├── font1.woff2
    │   ├── font2.woff2
    │   ├── index.css
    ├── base/
    │   ├── app.css
    │   ├── grid.css
    │   ├── preloader.css
    │   ├── utility.css
    │   └── index.css
    ├── theme/
    │   ├── tokens/
    │   │   ├── background-tokens.css
    │   │   ├── content-tokens.css
    │   │   ├── border-tokens.css
    │   ├── variables/
    │   │   └── index.css
    │   └── index.css
    ├── typography/
    │   ├── fonts/
    │   │   ├── font1.woff2
    │   │   ├── font2.woff2
    │   │   ├── .
    │   │   └── .
    │   ├── tokens/
    │   │   ├── body-tokens.css
    │   │   ├── display-tokens.css
    │   │   ├── heading-tokens.css
    │   │   └── button-tokens.css
    │   ├── variables/
    │   │   └── index.css
    |   ├── font-face.css
    │   └── index.css
    ├── README.md
    ├── index.css
    └── package.json

License

MIT

This CSS library is customized for use in Groww projects. Use at your own risk.

@groww-tech/mint-css