amenui
en·中 github ↗ v0.0.1
01文档 02组件 03实验室 04作品
en·中github ↗
×

文档 /文档 /

文档

指南、概念和参考,以及每个组件的页面和它的实时示例。

01开始

  • 01.1介绍

    amenui 是一个自己画每一个像素的界面框架,用 Rust 和 wgpu 写成,同一份代码跑在原生窗口和网页里。屏幕上的每一样东西——字形、形状、图片、三维的网格——都是一个带真实轮廓的实例,能按自己的轮廓松开、变形、再合上;它看起来怎样,是一种可以换的材质。

  • 01.2安装

    先选界面放在哪里。三种宿主画出来的像素一样:所有东西都由框架自己画,宿主只给它一块画面、输入和时间。

  • 01.3第一个视图

    视图是从状态到元素树的函数,更新是从状态和消息到新状态的函数。消息是普通的值。

  • 01.4项目结构

    amenui 仓库里各部分在哪。这个 crate 是一个库加几个命令行工具;这个网站、组件展示和实验室在另一个仓库 amenui-dev/website 里,它像普通应用一样依赖 amenui。

02指南

  • 02.1表单

    表单和别的一样,是状态和消息:状态里存着每一个值,每个控件每改一次发一条消息, update 是唯一改值的地方。文字字段在状态里存一个 TextEdit ;数字控件键入时发 Edit::Draft ,回车或步进时发 Edit::Set ,Esc 时发 Edit::Cancel ,所以状态把草稿和值分开存;开关和复选框发新的值。

  • 02.2主题与深色模式

    主题是一组颜色,加上显示、正文、等宽三种用途的字体( style::THEMES )。颜色在视图里写成名字而不是数值: Paint::INK 、 TEXT 、 DIM 、 FAINT 、 GROUND 、 ACCENT ,以及色相 Paint::hue(i) ,所以同一个视图在每个主题里都对。深色和浅色是同一个视图的两个主题:用顶栏的“主题”菜单、…

  • 02.3多语言

    屏幕上的每段文字都来自消息目录,一种语言一个,所以应用换成任何语言都不用改视图。

  • 02.4从右到左

    一行的方向是从右到左时,它从右边开始排:在这一行(或任何祖先)上写 El::rtl(true) ,或者用一种从右往左读的语言。布局由 taffy 的 Direction::Rtl 完成;文字由 parley 按各自的方向排版,所以一段里混排拉丁字母和从右到左的文字时,逻辑顺序不乱。

  • 02.5无障碍

    画面由框架自己画,而不是用系统控件,所以运行时为辅助技术另外维护一份看不见的界面副本:无障碍镜像。每次重建时它和画面从同一棵树生成,两者不会对不上。

  • 02.6用 render 和树测试

    每个示例都能不开窗口、从外部驱动: render 在离屏画布上打开它,在从 0 开始的固定 60 Hz 时钟上、用固定的随机种子播放一串输入事件,把最后一帧写成 PNG、把排好的树写成 JSON。同样的参数给出逐字节相同的结果,所以图和树都能在测试或评审里直接比较。

  • 02.7性能

    只在有变化时画;只画变了的部分(两个框);滚动只移动、不重新布局;长列表只造看得见的行;材质可以在一半分辨率上画松开的像素。

  • 02.8开发

    The architecture reference maps what each module owns. This guide covers building, testing and the tools in this repository.

配方

03概念

  • 03.1概览

    每个消息之后,运行时调一次 view(&state) ,得到一棵新的 El 树,按 key 和上一棵比较,只重算变了的布局。状态是唯一的来源;组件从不自己动。

  • 03.2文字

    文字由 parley 排版、swash 栅格化,图集里每个像素存覆盖率和到笔画的带符号距离,所以每种材质都按字的真实轮廓画它。段落可以绕开任意形状排( .around )。滚动时字按整设备像素移动,不会重新取样。

  • 03.3材质与松开

    材质是第二遍的画法:plain、dottr、halftonr、charr、smudgr、carvr、glitchr、near、scribblr。静止时它们和 plain 一样(除了自己有静止样子的几种);松开时各有各的样子。 El::material(id) 给一棵子树另一种材质。快速滚动时每种材质留下自己的痕迹(见 DESIGN §1.8.3 )。

  • 03.4标注

    第三遍是标注层:按真实的排版结果画框、编号、尺寸、引线、刻度尺,从不松开。 El::annotate(text) 写一条说明, {xy} 换成元素中心的坐标。

设计

04组件

05参考

  • 05.1命令行

    组件像 shadcn/ui 那样以源码分发:把组件的文件拷进你的项目,在那里改。 amenui add 负责拷。

  • 05.2注册表结构

    registry.json 把每个组件列成可以拷贝的源码,和 shadcn/ui 的注册表一样。 amenui add 读它;文档里的组件页也由它生成。

  • 05.3组件清单

    组件以源码分发: amenui add <名字> 把一个组件和它依赖的文件拷进你的项目。

  • 05.4AGENTS.md

    amenui is a self-drawn interface framework in Rust (wgpu; the same code runs natively and on the web). Everything on screen — glyphs, shapes, pictures — is an instance with a…

  • 05.5llms.txt

    A self-drawn interface framework in Rust (wgpu, native and web). Views are plain trees of values; every glyph, shape and picture has a true outline that can loosen, morph and…

  • 05.6架构

    amenui is one Cargo package: a library, the amenui command line and two tools. Everything except render.rs and the shaders runs without a GPU, so the runtime can be driven and…

  • 05.7字体

    The fonts in assets/ are all under the SIL Open Font License 1.1. Their licenses are in assets/licenses/ . text::embedded() returns them compiled into the binary (about 14 MB,…

06更新记录

  • 06.1更新记录

    Newest first. The acceptance checks for each part are in DESIGN.md §7 .