# alan-ui

**Repository Path**: alannum3/alan-ui

## Basic Information

- **Project Name**: alan-ui
- **Description**: 手绘风格组件库
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://alan-ui.vercel.app
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-10-12
- **Last Updated**: 2025-04-22

## Categories & Tags

**Categories**: webui

**Tags**: 手绘风格, React, TypeScript, 组件库

## README

[![Build Status](https://travis-ci.org/3Alan/alan-ui.svg?branch=main)](https://travis-ci.org/3Alan/alan-ui)
[![Coverage Status](https://coveralls.io/repos/github/3Alan/alan-ui/badge.svg?branch=main)](https://coveralls.io/github/3Alan/alan-ui?branch=main)
[![npm version](https://badge.fury.io/js/@3alan%2Fui.svg)](https://badge.fury.io/js/@3alan%2Fui)

## 📦 Install

```bash
npm install @3alan/ui
```

```bash
yarn add @3alan/ui
```

## 🔨 Usage

```jsx
import { Button } from '@3alan/ui';

const App = () => <Button>awesome</Button>;
```

And import style manually:

```jsx
import '@3alan/ui/dist/index.css';
```

## TODO

- [ ] monorepo lerna
- [ ] 优化打包文件大小
- [ ] 重构 RoughWrap
- [ ] 移除 react-scripts、测试依赖
- [ ] Icon 移除三方库自己实现，可参考 [react-svg](https://github.com/tanem/react-svg)

## ✨✨

https://dribbble.com/sultonhand

https://github.com/rough-stuff

https://github.com/ooade/react-rough

https://github.com/excalidraw/excalidraw/tree/master/src/renderer

https://github.com/ant-design/ant-design