基盤・ツール

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は完成したアプリ画面ではなく、atoms、molecules、layout、state、event、render modelを組み合わせるためのRust基盤です。ホストはSplitPaneやToolbarなどを選び、固有の画面構成とframework接続を担当します。

必要な描画層だけ有効化する

既定はframework-neutralなcoreで、egui、text-raster、svg-raster、raster-hostをfeature単位で追加できます。共通契約を保ったまま、UI入力、文字・SVG raster、UI-tree描画をホストの構成に合わせて選択できます。

02 / KUC

入力から出力までの流れ

  1. 部品と設定を入力する

    ホストはSplitPaneを生成し、axis、ratio_percent、min/max_percent、handle_width_px、resize_mode、子ノードを設定します。設定値はbuilderとして連鎖でき、状態IDも部品ごとに保持されます。

  2. 操作を契約化する

    pointerやkeyboardのresize、ratio変更、reset、clampをUiActionとして適用します。SplitPane内部は比率を範囲内へ補正し、操作結果をcallback logとinteraction stateに変換します。

  3. render modelへ渡す

    部品はUiNodeへ変換され、axis、比率、handle、resize mode、共通状態を含むrender modelになります。最新HEADではraster-hostのCanvas、TextRenderer、UI-tree rendererなどへ接続できますが、アプリのwindowingやshellはホスト責務です。

03 / KUC

主要API・CLIの使い分け

SplitPaneAxis
HorizontalとVerticalを表し、分割方向を決めます。単なる表示ラベルではなく、render modelのaxisへ変換されるレイアウト契約です。
SplitPaneResizeMode
PointerOnly、KeyboardOnly、PointerAndKeyboard、Disabledを表します。Disabledではhandleをfocus可能にせず、ホストの入力経路を明示的に制限できます。
比率・clamp設定
ratio_percentが現在比率、min_percentとmax_percentが許容範囲、reset_percentが復帰値です。入力値は設定された範囲にclampされ、範囲外の要求をそのまま描画しません。
raster-host公開契約
raster-host featureではCanvas、TextRenderer、UiTreeCanvasRenderer、UiTreeInteractionSurfaceなどが公開されます。描画とhit/interactionの実装をまとめられますが、featureを有効化しないcore利用者には追加依存を要求しません。

04 / KUC

具体例で理解する

SplitPaneの操作契約を組み込む

SplitPaneを水平50%で作り、20〜80%にclampし、UiActionで64%へ変更してからkeyboard resizeやresetを適用します。公開crateの操作型を使うため、ホストはUI frameworkのイベントをUiActionへ変換し、結果のcallback logを自分の状態管理へ取り込めます。

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 workspaceとfeatureを準備する

katana-ui-coreを依存に追加し、framework-neutralな利用ならdefault featureのまま開始します。eguiやraster hostが必要な場合だけCargo featureを有効化し、feature固有の依存をアプリへ取り込みます。

ホストがshellと検証を担う

AppShellやページテンプレートを含む完成アプリではありません。eguiやraster hostの接続層を利用しても、アプリ固有の画面構成とウィンドウ管理はホスト側で組み立てます。Storybookは開発用の検証環境なので、実際のホストでも入力・レイアウト・描画を確認してください。

根拠

調査時点の公開リポジトリに基づく紹介です。リンク先の固定コミットで実装と手順を確認できます。

リポジトリREADMEc3e80cb9098c
根拠 · KUC
すべての製品