# Pixelium Design

Pixelium Design – A pixel-art UI component library for Vue, built with TypeScript and Vite. Nostalgic aesthetics, tree-shakable components, dark and light themes, full type safety, ready to use right out of the box.

[中文](./README.zh.md)

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

## 🚀 Tech Stack

- **Vue 3** – Full modern features ⚗️ including Composition API
- **TypeScript** – Built on TS type system ✅ for out-of-the-box type safety
- **Vite** – Lightning-fast cold start ⚡ + HMR 🔥, production build via Rollup 📦
- **oxlint** – Blazing-fast Rust linter 🦀 to keep code quality & consistency ✨

## 🎨 Features

- **Pixel Aesthetics** – Retro pixel look 👾 with customizable resolution & palette 🎮
- **OKlab Palette** – Theme generator 🌈 based on the OKlab color model for one-click custom palettes 🎨
- **Tree-shakable** – Each component individually exported 🧩; unused code auto-dropped 🗑️
- **Dark Mode** – Supports dark mode 🌙 following system preference or manual toggle 🔦

## Documentation & Support

- **Documentation**: [View the documentation](https://shika-works.github.io/pixelium-design/) to learn more about features and usage.
- **Support**: Encounter any issues? Feel free to submit an [Issue](https://github.com/shika-works/pixelium-design/issues) or [Pull Request](https://github.com/shika-works/pixelium-design/pulls).

## License

Pixelium Design is released under the [MIT License](./LICENSE).  
This project uses the following third-party assets:

- **Font**: [Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font), licensed under [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL)
- **Icons**: Icons from Pixel Icon Library by HackerNoon, [@hackernoon/pixel-icon-library](https://github.com/hackernoon/pixel-icon-library), licensed under [CC BY 4.0 International](https://pixeliconlibrary.com/license/)

---

Thank you for using Pixelium Design.

# Pixelium Design

Pixelium Design – A pixel-art UI component library for Vue, built with TypeScript and Vite. Nostalgic aesthetics, tree-shakable components, dark and light themes, full type safety, ready to use right out of the box.

[中文](./README.zh.md)

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

## 🚀 Tech Stack

- **Vue 3** – Full modern features ⚗️ including Composition API
- **TypeScript** – Built on TS type system ✅ for out-of-the-box type safety
- **Vite** – Lightning-fast cold start ⚡ + HMR 🔥, production build via Rollup 📦
- **oxlint** – Blazing-fast Rust linter 🦀 to keep code quality & consistency ✨

## 🎨 Features

- **Pixel Aesthetics** – Retro pixel look 👾 with customizable resolution & palette 🎮
- **OKlab Palette** – Theme generator 🌈 based on the OKlab color model for one-click custom palettes 🎨
- **Tree-shakable** – Each component individually exported 🧩; unused code auto-dropped 🗑️
- **Dark Mode** – Supports dark mode 🌙 following system preference or manual toggle 🔦

## Documentation & Support

- **Documentation**: [View the documentation](https://shika-works.github.io/pixelium-design/) to learn more about features and usage.
- **Support**: Encounter any issues? Feel free to submit an [Issue](https://github.com/shika-works/pixelium-design/issues) or [Pull Request](https://github.com/shika-works/pixelium-design/pulls).
- Please read the [Conventional Commits](./conventional-commits.md) specification before committing.

## License

Pixelium Design is released under the [MIT License](./LICENSE).  
This project uses the following third-party assets:

- **Font**: [Fusion Pixel](https://github.com/TakWolf/fusion-pixel-font), licensed under [SIL OFL 1.1](https://github.com/TakWolf/fusion-pixel-font/blob/master/LICENSE-OFL).
- **Icons**:
  - Icons from Pixel Icon Library by HackerNoon, [@hackernoon/pixel-icon-library](https://github.com/hackernoon/pixel-icon-library), licensed under [CC BY 4.0 International](https://pixeliconlibrary.com/license/).
  - The open-source version of [pixelarticons](https://pixelarticons.com/). The open-source version is licensed under [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE).

---

Thank you for using Pixelium Design.