# boros

> TDCX Design System

Latest version **0.4.0** (published 2020-04-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install boros
pnpm add boros
yarn add boros
bun add boros
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2020-04-28 |
| First published | 2020-02-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 98.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ali Elkhateeb |
| Maintainers | tdcx |
| Keywords | tdcx design system, tdcx, boros |

## Links

- npm: https://www.npmjs.com/package/boros
- Repository: git@gitlab.teledirectgroup.com:ali.elkhateeb/boros
- npm.io page: https://npm.io/package/boros

## Dependencies (8)

- [clsx](https://npm.io/package/clsx.md) ^1.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [recharts](https://npm.io/package/recharts.md) ^2.0.0-beta.5
- [prop-types](https://npm.io/package/prop-types.md) latest
- [react-countup](https://npm.io/package/react-countup.md) ^4.3.3
- [@date-io/moment](https://npm.io/package/@date-io/moment.md) ^1.3.13
- [react-dropzone-uploader](https://npm.io/package/react-dropzone-uploader.md) ^2.11.0

## Recent versions

- 0.4.0 (latest) — 2020-04-28
- 0.3.8 — 2020-04-15
- 0.3.7 — 2020-04-07
- 0.3.6 — 2020-04-07
- 0.3.5 — 2020-04-06
- 0.3.4 — 2020-04-06
- 0.3.3 — 2020-04-06
- 0.3.2 — 2020-04-03
- 0.3.1 — 2020-04-03
- 0.3.0 — 2020-04-03
- 0.2.1 — 2020-03-24
- 0.2.0 — 2020-03-23
- 0.1.0 — 2020-02-27

## README

# Boros - Design System for TDCX

[![pipeline status](http://gitlab.teledirectgroup.com/ali.elkhateeb/boros/badges/master/pipeline.svg)](http://gitlab.teledirectgroup.com/ali.elkhateeb/boros/commits/master)
[![coverage report](http://gitlab.teledirectgroup.com/ali.elkhateeb/boros/badges/master/coverage.svg)](http://gitlab.teledirectgroup.com/ali.elkhateeb/boros/commits/master)

Boros is the design system for TDCX built on [Material-UI](https://www.material-ui.com).

## Install

`npm install boros --save`

## Usage

#### Basic:
##### Apply Boros default theme (in the top level of your react tree)
```js
import {BorosThemeProvider, Button} from 'boros';

const App = () => {
    return <BorosThemeProvider>
        <Button variant="contained" color="primary">Button</Button>
    </BorosThemeProvider>;
};
```

#### Advanced:
##### Apply Boros theme but override some of the attributes
```js
import {createMuiTheme} from "@material-ui/core";
import {BorosThemeProvider, Button} from 'boros'; 

const theme = createMuiTheme({
    palette: {
        primary: {
            main: '#FFFFFF',        
        }    
    }
});

const App = () => {
    return <BorosThemeProvider theme={theme}>
        <Button variant="contained" color="primary">Button</Button>
    </BorosThemeProvider>;
};
```
You can find the list of attributes [here](https://material-ui.com/customization/default-theme/?expand-path=$.palette#explore).

## API

The Components API is the same as [Material-UI](https://www.material-ui.com).

## Contributing
The following commands should get you started:

```sh
npm install
npm start
```
open http://localhost:3001/ in browser

## Testing
To run the tests locally just run `jest` in the root folder
```sh
npm run test
```
You'll see the coverage data in your console, please maintain coverage above `90%` at least, preferably `100%`.

## License
The files included in this repository are licensed under the ISC license.

---
_Source: https://npm.io/package/boros · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._