基础设施与工具

KatanA UI Core

不依赖特定 UI 框架的 Rust UI 基础。汇集组件状态、事件、主题和渲染契约,可选择所需的连接层。

构建可复用 UI 组件和应用显示基础的 Rust 开发者

01

已实现功能

基础组件以及 SplitPane、Toolbar、StatusBar 等复合组件

依据

主题、事件、渲染模型和窗口相关的中立 API

依据

可选的 egui 连接以及文本·SVG 光栅化功能

依据

02

开始使用

  1. 准备 Rust 和 just,并获取代码仓库。
  2. 通过 just storybook 试用组件,集成时只启用需要的功能。

请准备 Rust 和必要的开发工具,并在导入前通过链接的 README 确认环境要求。示例命令是功能入口,不保证在所有环境中运行。

依据
sh
git clone https://github.com/HiroyukiFuruno/katana-ui-core.git
cd katana-ui-core
just storybook

01 / KUC

使用场景

使用中性 UI 部件组装屏幕

KUC 不是一个完整的应用程序屏幕,而是用于组合原子、分子、布局、状态、事件和渲染模型的 Rust 基础。宿主选择SplitPane、Toolbar等,并负责具体的屏幕配置和框架连接。

仅启用必要的绘图层

默认是与框架无关的核心,您可以在功能单元中添加 egui、text-raster、svg-raster 和 raster-host。您可以根据宿主配置选择 UI 输入、文本/SVG 光栅和 UI 树绘图,同时保持通用契约。

02 / KUC

从输入到输出的流程

  1. 输入零件和设置

    宿主生成一个SplitPane并设置axis、ratio_percent、min/max_percent、handle_width_px、resize_mode和子节点。设置值可以作为构建器链接起来,并且还为每个部分维护状态 ID。

  2. 将交互操作映射为契约

    将指针和键盘调整大小、比例更改、重置和夹紧应用为 UiAction。在SplitPane内部,在范围内修正比例,并将操作结果转换为回调日志和交互状态。

  3. 传递给渲染模型

    该部件转换为 UiNode,并成为包含轴、比例、手柄、调整大小模式和公开状态的渲染模型。使用最新的 HEAD,您可以连接到 raster-host 的 Canvas、TextRenderer、UI-tree 渲染器等,但应用程序的窗口和 shell 是宿主的责任。

03 / KUC

主要 API 与 CLI

SplitPaneAxis — 分割方向
SplitPaneAxis 表示 Horizontal 和 Vertical,并确定分割方向。它不仅是显示标签,而是会转换为 render model 的 axis 的布局契约。
SplitPaneResizeMode — 输入模式
分别代表PointerOnly、KeyboardOnly、PointerAndKeyboard、Disabled。禁用不会使句柄成为焦点,并允许您显式限制宿主输入路径。
比率/钳位设置
ratio_percent 是当前分割比率,min_percent 和 max_percent 是允许范围,reset_percent 是重置时恢复的比率。输入值会 clamp 到设定范围,不会直接按越界的请求绘制。
栅格-宿主公开协议
raster-host 功能公开了 Canvas、TextRenderer、UiTreeCanvasRenderer、UiTreeInteractionSurface 等。您可以集成绘图和点击/交互实现,但对于不启用功能的核心用户不需要额外的依赖项。

04 / KUC

通过示例理解

合并 SplitPane 操作契约

以 50% 水平创建一个 SplitPane,将其限制为 20-80%,使用 UiAction 将其更改为 64%,然后应用键盘调整大小并重置。因为我们使用公开 crate 操作类型,所以宿主可以将 UI 框架事件转换为 UiActions,并将生成的回调日志合并到自己的状态管理中。

rust
use katana_ui_core::component::ComponentAction;
use katana_ui_core::interaction::UiAction;
use katana_ui_core::layout::{SplitPane, SplitPaneAxis, SplitPaneResizeSource, SplitPaneResizeMode};

fn main() {
    let mut split = SplitPane::new()
        .axis(SplitPaneAxis::Horizontal)
        .ratio_percent(50)
        .min_percent(20)
        .max_percent(80)
        .resize_mode(SplitPaneResizeMode::PointerAndKeyboard);
    let target = split.state_id().clone();
    let _ = split.apply_action(&UiAction::split_pane_set_ratio(target.clone(), 64));
    let _ = split.apply_action(&UiAction::split_pane_resize_by(
        target.clone(),
        4,
        SplitPaneResizeSource::Keyboard,
    ));
    let _ = split.apply_action(&UiAction::split_pane_reset_ratio(target));
    println!("ratio={}", split.ratio_percent_value());
}

05 / KUC

集成条件与职责边界

准备 Rust 工作区和功能

将 katana-ui-core 添加到依赖项中,并从框架中立使用的默认功能开始。仅当您需要 egui 或光栅宿主时才启用 Cargo 功能,并将特定于功能的依赖项合并到您的应用程序中。

Host 负责 shell 和验证

它不是一个包含 AppShell 和页面模板的完整应用程序。即使您使用egui或光栅宿主连接层,特定于应用程序的屏幕配置和窗口管理也是在宿主端组装的。 Storybook是开发的测试环境,请在实际宿主上检查输入、布局、绘图。

依据

内容基于调查时点的公开代码仓库。可通过链接中的固定提交确认实现和使用方法。

代码仓库阅读指南c3e80cb9098c
依据 · KUC
全部产品