# @resir014/chungking-react

> @resir014's personal design system.

Latest version **0.3.1** (published 2021-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @resir014/chungking-react
pnpm add @resir014/chungking-react
yarn add @resir014/chungking-react
bun add @resir014/chungking-react
```

## 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.3.1 |
| Published | 2021-08-04 |
| First published | 2020-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 377.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Resi Respati |
| Maintainers | resir014 |

## Links

- npm: https://www.npmjs.com/package/@resir014/chungking-react
- Repository: https://github.com/resir014/chungking
- Homepage: https://github.com/resir014/chungking#readme
- Issues: https://github.com/resir014/chungking/issues
- npm.io page: https://npm.io/package/@resir014/chungking-react

## Dependencies (7)

- [clsx](https://npm.io/package/clsx.md) ^1.1.1
- [csstype](https://npm.io/package/csstype.md) ^3.0.8
- [polished](https://npm.io/package/polished.md) ^4.1.3
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [react-fast-compare](https://npm.io/package/react-fast-compare.md) ^3.2.0
- [@chakra-ui/css-reset](https://npm.io/package/@chakra-ui/css-reset.md) ^1.0.0
- [@spicy-ui/styled-system](https://npm.io/package/@spicy-ui/styled-system.md) ^0.0.1-alpha.3

## Recent versions

- 0.3.1 (latest) — 2021-08-04
- 0.3.2-canary.8 (canary) — 2022-11-20
- 0.3.2-canary.7 — 2022-05-03
- 0.3.2-canary.6 — 2021-11-28
- 0.3.2-canary.5 — 2021-11-28
- 0.3.2-canary.4 — 2021-11-28
- 0.3.2-canary.3 — 2021-10-29
- 0.3.2-canary.2 — 2021-10-29
- 0.3.2-canary.1 — 2021-10-27
- 0.3.2-canary.0 — 2021-10-27
- 0.3.0 — 2021-08-03
- 0.2.4-canary.2 — 2021-08-01
- 0.2.4-canary.1 — 2021-08-01
- 0.2.4-canary.0 — 2021-07-22
- 0.2.3 — 2021-02-17
- … 7 more at https://npm.io/package/@resir014/chungking-react/versions

## README

# @resir014/chungking-react

> @resir014's personal design system.

## Install

```bash
# yarn
$ yarn add @resir014/chungking-react @emotion/react @emotion/styled
# npm
$ npm i @resir014/chungking-react @emotion/react @emotion/styled
```

You will also need the [Feather icons set](https://feathericons.com/), run this command to install them:

```bash
# yarn
$ yarn add react-feather
# npm
$ npm i react-feather
```

## Usage

First, wrap your entire app inside `ChungkingProvider`. This will apply the Emotion theme provider, as well as style resets.

```tsx
import { ChungkingProvider } from '@resir014/chungking-react'

export default function MyApp() {
  return (
    <ChungkingProvider>
      <App />
    </ChungkingProvider>
  )
}
```

> For Next.js, you need to set this up in `pages/_app.js` or `pages/_app.tsx`

### Example

The following is an example for the Button component.

```tsx
import * as React from 'react'
import { Button } from '@resir014/chungking-react'

export default function Component() {
  return <Button>Push Me</Button>
}
```

## Developing Locally

Install the project dependencies.

```sh-session
$ yarn
```

To start developing components, you have to run the Storybook server.

```sh-session
$ yarn storybook
info Storybook started on => http://localhost:6006/
```

The storybook server is available at `http://localhost:6006`. Note that any new component needs to have at least one story as a demo, and some tests.

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