# adorable-react

> [![GitHub license](https://img.shields.io/github/license/Maricaya/adorable-react)](https://github.com/Maricaya/adorable-react/blob/master/LICENSE) [![CircleCI](https://circleci.com/gh/Maricaya/adorable-react.svg?style=svg)](https://app.circleci.com/pipeli

Latest version **0.0.6** (published 2020-10-19) · 0 weekly downloads

## Install

```sh
npm install adorable-react
pnpm add adorable-react
yarn add adorable-react
bun add adorable-react
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2020-10-19 |
| First published | 2020-07-09 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 27.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | xlchu |

## Links

- npm: https://www.npmjs.com/package/adorable-react
- npm.io page: https://npm.io/package/adorable-react

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.13.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.1
- [tiny-pinyin](https://npm.io/package/tiny-pinyin.md) ^1.3.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.2.0

## Recent versions

- 0.0.6 (latest) — 2020-10-19
- 0.0.5 — 2020-07-09

## README

# adorable-ui-react(持续更新中) 使用 TypeScript、React Hooks
# 一套好用的 PC 端 React 组件 
[![GitHub license](https://img.shields.io/github/license/Maricaya/adorable-react)](https://github.com/Maricaya/adorable-react/blob/master/LICENSE)
[![CircleCI](https://circleci.com/gh/Maricaya/adorable-react.svg?style=svg)](https://app.circleci.com/pipelines/github/Maricaya/adorable-react)
[![npm version](https://badge.fury.io/js/adorable-react.svg)](https://badge.fury.io/js/adorable-react)
[![GitHub issues](https://img.shields.io/github/issues/Maricaya/adorable-react)](https://github.com/Maricaya/adorable-react/issues)
[![GitHub forks](https://img.shields.io/github/forks/Maricaya/adorable-react)](https://github.com/Maricaya/adorable-react/network)
[![GitHub stars](https://img.shields.io/github/stars/Maricaya/adorable-react)](https://github.com/Maricaya/adorable-react/stargazers)

> 组件仅供学习交流，请勿在生产环境中使用

# 特性
- 使用 TypeScript 开发，提供完整的类型定义文件。
- 使用 React Hooks 进行状态管理。
- 深入每个细节的主题定制能力。

- 文档地址：
https://maricaya.github.io/adorable-react/example.html
# 组件列表
- [x] Icon
- [ ] button
- [x] Dialog
- [x] Layout
- [ ] Form
- [ ] Scroll
- [ ] Tree

# 安装
```bash
npm install adorable-react
yarn add adorable-react
```
# 使用
```jsx
import * as React from 'react'
import * as ReactDOM from 'react-dom'
import { Button } from 'adorable-react'
import 'adorable-react/lib/index.css'

ReactDOM.render(
  <div>
    <Button>Default</Button>
  </div>,
  mountNode
)

```
需要注意的是，样式文件需要单独引入。


# 特别提醒
使用 adorable-react 时，需要使用 border-box 盒模型，否则会影响样式。代码示例：
```css
*,
*::before,
*::after {
  margin: 0;
  padding: 0;
  box-sizing: border-box;
}
```

# License
This project is licensed under the terms of the MIT license.

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