# macroui-lit **Repository Path**: macroui/macroui-lit ## Basic Information - **Project Name**: macroui-lit - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-18 - **Last Updated**: 2026-11-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # MacroUI 基于 Lit 的 Web Components 组件库,`mui-*` 自定义元素,框架无关,MIT 协议。 - 文档站点: - npm 包: - 源码: 使用者请直接看文档站点或子包 README:[packages/macroui-lit/README.md](packages/macroui-lit/README.md)。本页只讲如何从源码构建与贡献。 ## 仓库结构 仓库用 npm workspaces 管理,目前只有一个可发布包: ``` macroui-lit/ ├─ packages/ │ └─ macroui-lit/ # @macroui/lit —— 组件库本体(98 个组件) ├─ package.json # 工作区根配置、共享 devDependencies └─ LICENSE.md ``` 日常开发只需在 `packages/macroui-lit/` 目录内操作。 ## 技术栈 - 组件:Lit(自定义元素基类 + 响应式数据绑定) - 构建:自研脚本 + esbuild 打包,生成两份产物 - `dist-cdn/`:自包含预打包版,供浏览器直连 CDN 使用 - `dist/`:裸模块版,供打包器解析 - 文档:11ty(Eleventy),从组件 CEM(Custom Elements Manifest)生成 API 表 - 测试:Web Test Runner,Chromium / Firefox / WebKit 三浏览器 ## 从源码开始 需要 Node.js 14.17 或更高版本。 ```bash git clone https://github.com/macroui/macroui-lit cd macroui-lit npm install cd packages/macroui-lit npm start ``` `npm start` 会启动开发服务器并在首次构建后打开浏览器。自定义元素无法热替换,工具链会在源码变更后自动刷新页面,但没有真正的 HMR。 ## 构建与测试 ```bash cd packages/macroui-lit npm run build # 生成 dist/ 与 dist-cdn/ npm run build:serve # 构建后启动 http-server 预览(localhost:4000) npm test # 全量测试(三浏览器) npm run test:chromium # 仅 Chromium,本地迭代更快 npm run test:parts # 校验 @csspart 文档与实际渲染一致 npm run test:anatomy # 校验文档示例能解析到对应组件 npm run verify # 格式 + parts + anatomy + build + 测试,发布前完整校验 ``` ## 新增组件 ```bash cd packages/macroui-lit npm run create mui-tag-name ``` 脚手架会生成源码、样式与文档页三件套。启动开发服务器后,新组件会出现在侧栏的 Components 分类下。 ## 依赖放置规则 - 跨包共享、非运行时依赖(prettier、eslint 等)放工作区根的 `devDependencies`:`npm install -D -w prettier` - 运行时依赖放具体包的 `dependencies`(如 lit)。漏放会导致通过 npm 安装时缺依赖 - 包私有的 devDependencies 可直接在该包目录内安装 ## 贡献 欢迎贡献。提交前请阅读 [贡献指南](packages/macroui-lit/docs/docs/resources/contributing.md),并跑通 `npm run verify`。 ## 协议 MIT License,详见 [LICENSE.md](LICENSE.md)。