01
已實作功能
02
開始使用
- 準備 Rust 與 just,並取得儲存庫。
- 透過 just storybook 試用元件,整合時只啟用需要的功能。
請準備 Rust 與必要的開發工具,並在導入前透過連結的 README 確認環境需求。執行範例是功能入口,不保證在所有環境中運作。
依據git clone https://github.com/HiroyukiFuruno/katana-ui-core.git
cd katana-ui-core
just storybook01 / KUC
使用情境
使用中性 UI 部件組裝螢幕
KUC 不是一個完整的應用程式螢幕,而是用於組合原子、分子、佈局、狀態、事件和渲染模型的 Rust 基礎。宿主選擇SplitPane、Toolbar等,並負責具體的螢幕配置和框架連線。
僅啟用必要的繪圖層
預設是與框架無關的核心,您可以在功能單元中新增 egui、text-raster、svg-raster 和 raster-host。您可以根據宿主配置選擇 UI 輸入、文本/SVG 光柵和 UI 樹繪圖,同時保持通用契約。
02 / KUC
從輸入到輸出的流程
輸入零件和設定
宿主生成一個SplitPane並設定axis、ratio_percent、min/max_percent、handle_width_px、resize_mode和子節點。設定值可以作為構建器連結起來,並且還為每個部分維護狀態 ID。
將互動操作對映為契約
將指標和鍵盤調整大小、比例更改、重置和夾緊應用為 UiAction。在SplitPane內部,在範圍內修正比例,並將操作結果轉換為回撥日誌和互動狀態。
傳遞給渲染模型
該部件轉換為 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,並將生成的回撥日誌合併到自己的狀態管理中。
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是開發的測試環境,請在實際宿主上檢查輸入、佈局、繪圖。
依據
內容根據調查時點的公開儲存庫。可透過連結中的固定提交確認實作與使用方式。