# mcui

**Repository Path**: al01/mcui

## Basic Information

- **Project Name**: mcui
- **Description**: 基于Minecraft Wiki风格的UI库
- **Primary Language**: Unknown
- **License**: CC-BY-SA-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-18
- **Last Updated**: 2026-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Minecraft WIKI UI Design (mcui)

一个基于 [Minecraft Wiki](https://zh.minecraft.wiki) 风格的现代化 UI 组件库，使用 Nuxt 4 与 Vue 3 构建。该项目旨在提供一套完整的、风格化的组件系统，用于构建具有 Minecraft 维基视觉风格的应用程序。

## ✨ 主要特性

-   **高度还原的视觉风格**：复刻了 Minecraft Wiki 的经典界面设计，包括配色、字体和排版。
-   **完整的主题支持**：内置了基于不同游戏版本/维基的主题切换，包括亮色/暗色模式，以及 Dungeons, Legends, Earth, Story Mode, China Edition 等专属配色。
-   **丰富的组件生态**：提供了基础表单组件、维基特有布局组件（如信息框 Infobox、时间线 Timeline）以及交互反馈组件。
-   **Nuxt 4 全栈集成**：基于最新的 Nuxt 4 框架，充分利用其现代化的构建工具和组件化架构。

## 📦 组件列表

本项目包含以下核心组件，涵盖了维基页面展示与表单交互的方方面面：

### 基础组件 (Basic)
-   **UiButton**: 包含多种变体（主要操作、成功、危险、警告、禁用、块级显示、方形图标按钮）。
-   **UiInput**: 文本输入框，支持多种状态样式。
-   **UiSelect**: 下拉选择框。
-   **UiCheckbox / UiRadio / UiSwitch / UiSlider**: 完整的表单交互组件库。
-   **UiLabel**: 表单标签。

### 维基特色 (Wiki Specific)
-   **UiInfobox**: 维基信息框组件，用于展示游戏物品或生物的详细属性。
-   **UiTimeline**: 时间线组件，适合展示游戏版本历史或事件脉络。
-   **UiHighlight**: 高亮展示区块，常用于首页焦点图或重要公告。
-   **UiSection**: 页面内容分区组件。

### 布局与导航 (Layout & Navigation)
-   **UiCollapse**: 内容折叠组件（手风琴效果）。
-   **UiTabs**: 标签页切换。
-   **UiTable**: 数据表格。
-   **UiPagination**: 分页导航。

### 交互反馈 (Feedback)
-   **UiDialog**: 模态对话框，支持复杂的交互场景。
-   **UiMessage (Toast)**: 轻量级消息通知。
-   **UiProgress**: 进度条。
-   **UiToggle**: 开关组件。

## 🎨 主题与样式

样式系统设计极为灵活，支持通过 CSS 类名进行全局或局部的主题切换。

**支持的主题场景：**
-   **通用明暗色系**：`.wgl-theme-light`, `.wgl-theme-dark`。
-   **游戏专属门户**：
    -   `.mp-portal-minecraft` (Minecraft Wiki)
    -   `.mp-portal-dungeons` (Dungeons Wiki)
    -   `.mp-portal-legends` (Legends Wiki)
    -   `.mp-portal-earth` (Earth Wiki)
    -   `.mp-portal-story-mode` (Story Mode Wiki)
    -   `.mp-portal-china` (China Edition Wiki)

所有组件均已针对上述主题进行了深度适配，确保在不同门户下呈现正确的视觉风格。

## 🚀 快速开始

1.  **克隆项目**
    ```bash
    git clone https://gitee.com/al01/mcui.git
    cd mcui
    ```

2.  **安装依赖**
    ```bash
    # 假设使用 Bun (根据 lock 文件)
    bun install
    
    # 或使用 npm/pnpm
    npm install
    pnpm install
    ```

3.  **运行开发服务器**
    ```bash
    bun run dev
    ```

访问 `http://localhost:3000` 即可查看组件演示（通常位于 `/ui` 路由）。

## 📄 许可证

本项目采用 **知识共享署名-相同方式共享 4.0 国际 (CC BY-SA 4.0)** 许可协议。

这意味着您可以自由地：
-   **分享**：在任何媒介或格式复制并分发本材料的原始副本。
-   **改编**： remix, 转换, 并在材料基础上进行创作。

**惟须遵守以下条件：**
-   **署名**：您必须给予适当的荣誉，提供指向本许可证的链接，并指明是否对材料进行了更改。您可以采用任何合理的方式这样做，但不得以暗示许可人对您的使用予以认可或支持的方式进行。
-   **相同方式共享**：如果您对材料进行 remix, 转换, 或在其基础上进行创作，您必须按照相同的许可证分发您的贡献。

## 📢 署名

本 UI 库基于 **Minecraft Wiki** 官方提供的样式表并进行了现代化的组件化重构与修改。

**原始来源：**
-   Minecraft Wiki (https://minecraft.wiki)

感谢 Minecraft Wiki 团队提供的开源设计资源，使本项目得以实现。