Skip to content

xiaodye/indigo-ui

Repository files navigation

Indigo UI

一个基于 dumi2 开发的 react 组件库

NPM version NPM downloads CI

特性

  • ⚡️ 使用 React 18、Dumi 2 和 Pnpm,保证快速高效的开发体验。
  • 🦾 使用 TypeScript, 提供一流的类型支持。
  • 🗂 提供 cli 工具,支持快速创建应用。
  • ⚙️ 使用 Jest 和 @testing-library/react 进行单元测试。
  • 🌳 Eslint Prettier Stylelint commitlint 保证代码风格和质量。
  • 🎨 使用 GithubActions 进行 CI/CD。

安装

  1. 从 yarn、npm 或者 pnpm 安装并引入 indigo-ui
pnpm add @indigo-ui/components
  1. 通过 cli 工具一键创建应用(beta)
pnpm i -g @indigo-ui/cli
create-indigo-ui-app

Snipaste_2024-02-25_18-39-59.png

快速开始

import { Button, Space } from '@indigo-ui/components';
import { FC } from 'react';

const App: FC = () => {
  return (
    <Space>
      <h1>indigo-ui</h1>
      <Button>默认按钮</Button>
      <Button type="primary">主要按钮</Button>
    </Space>
  );
};

export default App;

后续计划

  • 逐步改为 Monorepo 项目架构
  • 增加更多的组件支持
  • 提供 @indigo-ui/cli、@indiog-ui/hooks、@indigo-ui/icons
  • 支持 nginx 和 docker 部署文档站点