# @krishnahingu/ui-lib

Latest version **0.0.6-snapshot** (published 2022-04-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @krishnahingu/ui-lib
pnpm add @krishnahingu/ui-lib
yarn add @krishnahingu/ui-lib
bun add @krishnahingu/ui-lib
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6-snapshot |
| Published | 2022-04-22 |
| First published | 2022-04-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 160.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | krishnahingu |

## Links

- npm: https://www.npmjs.com/package/@krishnahingu/ui-lib
- npm.io page: https://npm.io/package/@krishnahingu/ui-lib

## Dependencies (9)

- [moment](https://npm.io/package/moment.md) ^2.29.1
- [@mui/lab](https://npm.io/package/@mui/lab.md) ^5.0.0-alpha.59
- [@mui/material](https://npm.io/package/@mui/material.md) ^5.5.2
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.4.1
- [@date-io/moment](https://npm.io/package/@date-io/moment.md) 1.x
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.8.1
- [styled-components](https://npm.io/package/styled-components.md) 5.3.3
- [@mui/icons-material](https://npm.io/package/@mui/icons-material.md) ^5.0.5
- [@mui/styled-engine-sc](https://npm.io/package/@mui/styled-engine-sc.md) ^5.0.3

## Recent versions

- 0.0.6-snapshot (latest) — 2022-04-22
- 0.0.5-snapshot — 2022-04-22
- 0.0.4-snapshot — 2022-04-22
- 0.0.3-snapshot — 2022-04-22
- 0.0.2-snapshot — 2022-04-22
- 0.0.1-snapshot — 2022-04-22

## README

# React Component Library as `ui-lib`


## Requirements
- Node 16.X
- Yarn 2.X
- Webpack 5.X
- Typscript
- TS-Node
- React 17.X

## Installation
- Clone the project from GitLab
- Use `yarn install` to update the packages.
- Use `yarn build` to build the project.
- local development *TBC*

* After successfull build, The project will create a `lib` directory 
* In `lib` directory there should be 3 types of exported module
    1. CommonJS
    2. Esm
    3. UMD


Now the exported module are ready to use in any react project using npm or yarn as `ui-lib` as dependency.

```javascript
// Example
import {Button} from 'ui-lib';

const MyComponent = ()=>{
    return(
        <Button>My Button</Button>
    )
}
```

## Storybook
----------------------------------------
### Run local development storybook
- use `yarn storybook` to run the dev server, it will run at `http://localhost:4200`
### Run build
- use `yarn build-storybook` to create production build of storybook. It will create separate directory of build file `storybook-static`.

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