# Pixelium Design

Pixelium Design – 基于 Vue 的像素风 UI 组件库，使用 TypeScript 与 Vite 构建。怀旧像素美学、可树摇组件、深浅主题、开箱即用、类型安全。

[English](./README.md)

[API 文档](https://shika-works.github.io/pixelium-design/)

## 🚀 技术栈

- **Vue 3** ‑ 支持 Composition API ⚗️ 等全部现代特性
- **TypeScript** ‑ 基于 TS 类型系统，开箱即用的类型安全 ✅
- **Vite** ‑ ⚡ 极速冷启动 + 热更新 🔥，生产环境基于 Rollup 构建 📦
- **oxlint** ‑ 🦀 用 Rust 编写的超快 Lint 工具，保障代码质量与一致性 ✨

## 🎨 功能特性

- **像素美学** ‑ 复古像素外观 👾，可自定义分辨率与调色 🎮
- **OKlab 调色板** ‑ 基于 OKlab 色彩模型的主题生成器 🌈，一键生成自定义调色板 🎨
- **树摇优化** ‑ 每个组件独立导出 🧩，未使用代码自动剔除 🗑️
- **暗黑模式** ‑ 🌙 支持暗黑模式，可跟随系统或手动切换 🔦

## 文档与支持

- **文档**：[查看文档](https://shika-works.github.io/pixelium-design/)以了解更多功能和使用方法。
- **支持**：在使用过程中遇到问题？欢迎提交 [Issue](https://github.com/shika-works/pixelium-design/issues) 或 [Pull Request](https://github.com/shika-works/pixelium-design/pulls)。
- 提交前请阅读 [Conventional Commits](./conventional-commits.zh.md) 规范。

## 许可证

Pixelium Design 使用[ MIT 许可证](./LICENSE)发布。  
本项目使用的第三方资源：

- **字体**：[Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font)，采用 [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL) 许可证。
- **图标**：
  - Icons from Pixel Icon Library by HackerNoon，[pixel-icon-library](https://github.com/hackernoon/pixel-icon-library)，采用 [CC BY 4.0 International](https://pixeliconlibrary.com/license/) 许可证。
  - [pixelarticons](https://pixelarticons.com/) 的开源版本，开源版本许可证采用了 [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) 协议。

---

感谢您使用 Pixelium Design。