@seakoi/console-kit

基于 React + TypeScript + Ant Design 的现代化组件库，为 Seakoi 控制台应用提供统一的 UI 组件。

特性

• 基于 Ant Design: 在 Ant Design 的基础上进行封装和扩展
• TypeScript 支持: 提供完整的类型定义，增强开发体验
• Storybook 文档: 集成 Storybook 提供组件预览和用法文档
• UnoCSS 支持: 使用 UnoCSS 提供现代化的 CSS 解决方案
• 按需加载: 支持 ES Module 格式，可按需引入组件
• 单元测试: 使用 Vitest 进行组件测试

安装

# 使用 npm
npm install @seakoi/console-kit

# 使用 pnpm
pnpm add @seakoi/console-kit

# 使用 yarn
yarn add @seakoi/console-kit

Alpha 版本

如果你想体验最新功能或参与测试，可以安装 alpha 预发布版本：

# 安装最新的 alpha 版本
npm install @seakoi/console-kit@alpha

# 安装特定的 alpha 版本  
npm install @seakoi/[email protected]

注意：Alpha 版本用于测试新功能，可能不稳定，不建议在生产环境中使用。

使用

import { Button } from '@seakoi/console-kit';

function App() {
  return (
    <Button type="primary">Hello Seakoi</Button>
  );
}

开发

# 安装依赖
pnpm install

# 启动 Storybook 开发环境
pnpm run start

# 构建组件库
pnpm run build

# 生成文档
pnpm run doc

# 运行测试
pnpm run test

组件列表

目前包含以下组件：

• Button: 基于 Ant Design 的按钮组件，支持不同类型、尺寸和状态

更多组件正在开发中...

文档

查看 在线文档 获取更多组件示例和用法说明：

贡献指南

1. Clone 本仓库
2. 创建您的特性分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Merge Request

许可证

MIT