返回首页
最新
# TelUI
TelUI 是一个基于 Electron 的用户界面框架，打包了一些可重用的前端基本组件——颜色工具、排版助手和基本结构样式——使您能够以最小的设置原型化简单的桌面用户界面想法。
## 特性
- 集成的 Electron 运行器（`npm start`），可即时提供 `index.html` 的桌面预览。
- 令牌化的样式层：`color.css`、`font.css`、`header.css` 和 `align.css` 使展示规则保持独立，易于重混。
- `animation.css` 中的微交互助手（例如，`.hover-fade`、`light`）用于细微的悬停状态或强调效果。
- 集成 Google Fonts（Funnel Display），以及可选的实用类，如 `.arial`。
- 在 `icons/` 下提供图标资源，帮助说明加载和状态。
## 快速开始
```bash
npm install
npm run start
```
该应用程序启动一个 800×600 的 Electron 窗口，加载 `index.html`。修改任何 CSS 或 HTML 文件后重启（或重新加载）以查看更改。
## 项目结构
```text
index.js # Electron 启动文件
index.html # 使用 TelUI 样式的演示画布
font.css # 排版工具和 Google Fonts 导入
color.css # 颜色令牌（例如，gentleblue、brightblue、gray/grey、green）
animation.css # 悬停淡出助手和光效过滤器
header.css # 头部容器的结构调整
align.css # `<center>` 助手，用于水平居中任何块元素
icons/ # 共享位图 / gif 资源（例如，loading.gif）
package.json # 依赖项和 npm 脚本
```
## 使用工具
1. 在您的 HTML 入口文件中引用所需的样式：
```html
<link rel="stylesheet" href="font.css">
<link rel="stylesheet" href="color.css">
<link rel="stylesheet" href="header.css">
<link rel="stylesheet" href="animation.css">
<link rel="stylesheet" href="align.css">
```
2. 应用提供的类或自定义元素标签：
```html
<gentleblue>
<header>
<h1>TelUI</h1>
</header>
<p class="arial">原型文本在这里。</p>
</gentleblue>
```
`font.css` 提供了 `.funneldisplay` 和 `.arial`。颜色令牌（`gentleblue`、`brightblue`、`gray`、`grey`、`green`）可以作为元素选择器使用，或者如果您更喜欢 `.gentleblue` 语法，可以转换为类。
3. 在需要的地方添加动画助手：
```html
<button class="hover-fade funneldisplay">悬停我</button>
<light>强调块</light>
```
`.hover-fade` 应用共享的不透明度/缩放过渡；`light` 标签提供了一个过滤的高亮包装，而无需触及内联样式。
4. 使用专用标签居中块元素：
```html
<center>
<button>CTA</button>
</center>
```
`align.css` 样式表将 `<center>` 限制为 `max-width: fit-content`，并使用自动水平边距，使任何嵌套元素保持居中，而无需额外的包装。
5. 通过指向资源目录重用图标：
```html
<img src="icons/loading.gif" alt="加载指示器">
```
## 扩展 TelUI
- 通过更新相应的 CSS 文件添加新的颜色令牌或排版助手；保持选择器声明性，并按类别组织。
- 对于额外的 Electron 行为（菜单、预加载脚本、IPC），扩展 `index.js`，同时保持以 UI 为中心的文件与框架无关。
- 当作为可分发应用程序发布时，配置 `electron-builder` 或您喜欢的打包工具；当前的设置故意保持简单。
## 许可证
除非在单独的文件中另有说明，TelUI 在 MIT 许可证下分发。请在重新分发 TelUI 或衍生作品时包含许可证文本。
网址：
https://github.com/eotter-beep/telui