Show HN: Shirei、ネイティブGoのクロスプラットフォームGUIフレームワーク
Show HN: Shirei, cross-platform GUI framework in native Go (github.com)
要約
Shireiは、Go言語でUIを記述できるクロスプラットフォームGUIフレームワークです。HTMLやJavaScriptは不要で、macOS、Windows、Linuxで同一の外観を持つプログラムを生成できます。特に、依存関係なしで自己完結型のGUIプログラムをLinuxで作成する最も簡単な方法を提供します。Immediate mode APIを採用しており、UIウィジェットの状態管理を不要にします。
全文翻訳
Shirei
Shireiは、Go言語で開発されたクロスプラットフォームGUIフレームワークで、Webベースのアプローチの軽量な代替として、開発エルゴノミクスに焦点を当てて設計されています。
- HTMLとJavaScriptではなく、純粋なGoでUIを構築します。
- ウィジェットオブジェクトを作成・維持するのではなく、状態の関数としてUIを記述します。
- Webの良い部分(均一なコンテナツリー、Flexboxライクなレイアウト)を使用します。
- カスタムコンポーネントは、呼び出し側が気にする必要のない内部状態を保持できます。
[画像: 名前とメールアドレスのフィールド、および保存ボタンがあるプロフィールフォーム]
func ProfileForm(profile *Profile) {
Container(Attrs(Expand, Pad(18), Gap(8)), func() {
Label("Profile", FontSize(22),
FontWeight(WeightBold))
Label("Name")
TextInput(&profile.Name)
Label("Email")
TextInput(&profile.Email)
Container(Attrs(Row, CrossMid, Gap(10)), func() {
if Button(SymITick, "Save") {
profile.Saved = true
}
if profile.Saved {
Label("All changes saved",
FontSize(12),
TextColor(145, 55, 34, 1))
}
})
})
}
幅広いユーティリティアプリケーションに適しています。
Electronの使用を避けたい場合に、TUIフレームワークに頼る代わりにShireiを試してみてください。
※ "Shirei" は "Simple Layout" の日本語発音に由来しています:シンプル・レイアウト → シレイ
Shireiは主要なプラットフォームすべてをサポートしています:
- Windows
- macOS
- Linux (Wayland, X11)
- iOS (iPhone)
- Android
このリポジトリにはいくつかのサンプルプログラムがあります。ライトモード(左)とダークモード(右)を比較したスクリーンショットを以下に示します:
Git History: コミット履歴を(線形に)素早く確認できます。
[画像: Git Historyのコミットリストと、ライトモードとダークモードの間で斜めに分割されたユニファイド差分]
Haystack: 非常に高速な「ファイル内検索」ツールです。
[画像: Haystackの検索結果が、ライトモードとダークモードの間で斜めに分割されている]
Piano: シンプルなキーボードピアノです。
Process Monitor: 実行中のプロセスがCPU/RAMをどのように使用しているかを素早く確認できます。
[画像: Process Monitorのテーブルと履歴チャートが、ライトモードとダークモードの間で斜めに分割されている]
プログラムの実行は go run . または go run ./pkg と簡単です。
モバイルフォンでアプリを素早く実行するための shirei_mobilerun を提供しています。
また、サポートされているすべてのターゲットプラットフォームのリリースバンドルを作成・管理するための shirei_bundle も提供しています。
デスクトッププラットフォーム(macOSを含む)では、CGOなしでクロスコンパイルが可能です。iOSでは依然としてCGOが必要です。
モチベーション
UIを作成するためのアプローチはいくつかありますが、この著者の経験では、他のアプローチと比較して、即時モード(immediate mode)が最も少ない労力で最大の柔軟性とパワーを提供してくれると一貫して感じています。
「即時モード」と言うとき、レンダリングメカニズムについて話しているのではなく、APIについて話しています。アプリケーションコードでウィジェットを「保持」しますか、それともアプリケーションの状態が与えられたときに、UIが「今」どうあるべきかを単に宣言しますか?
既存のGoのGUIフレームワークは、即時モードを謳っているものでさえ、ウィジェットを自分で保持する必要があるように見えます。
Shireiは、2つの強力なアイデアを組み合わせています:
- 通常のコード構造を使用してUIを構築し、コールバックなしで入力に応答します。
- Flexboxライクなシステムに基づいて要素を自動的にサイズ設定し、レイアウトします。
Shireiを使用する理由:
-
小さなネイティブバイナリを生成します(バイナリサイズは通常約10MBです)。
-
パフォーマンスとリソース使用量は、設計における最優先事項です。
-
学習しやすいAPIと、人間とAIの両方にとって高速なイテレーションサイクルです。
-
よりシンプルなUIコードで、ウィジェットオブジェクトではなくプログラムデータに集中できます。
-
Flexboxレイアウトモデルにより、スタイリングされたコンテナツリーを自由に配置してカスタムUIやコンポーネントを構築できます。
-
バッテリー付属:デフォルトウィジェット、堅牢なテキスト編集、仮想リスト、テーブル、モーダルが含まれています。
-
国際テキストサポート:C/C++のimguiライブラリに期待するかもしれないものとは異なり、Shireiは複雑なテキストシェーピングと双方向レイアウト、東アジア言語の入力メソッドエディタ(IME)、およびすべてのシステムフォントを使用する機能をサポートしています。
-
スナップショットテスト:ネイティブウィンドウを開いたりGPUを必要としたりせずに、通常のアプリケーションフレームを画像にレンダリングします。ヘッドレススナップショットは常にソフトウェアレンダラーを使用します。
-
デフォルトでGPUコンポジタを使用(macOS (Metal), iOS (Metal), Wayland (GLES), Android (GLES), Windows (D3D11), Web (WebGL2))。X11はソフトウェアのままです。
SHIREI_GPU=0または初期化失敗の場合はソフトウェアレンダラーにフォールバックします。 -
コンテナの属性(
NextAccessName,AssignAccess)にアクセスして、各フレームでクエリ可能なツリーを構築します。テスト実行(Drive tests)はアプリを起動し、ループバックUDP経由で名前でクリックします:docs/drive-tutorial.md。コマンドリスト:docs/drive.md。
制限事項
- Shireiアプリは、標準的な装飾を持つウィンドウは1つだけです。
- macOS、Linux Wayland、64ビットWindowsでの基本的なスクリーンリーダーサポートは、静的テキスト、ボタン、トグル、スライダーをカバーしています。範囲とテストについては、accessibility を参照してください。
- アプリケーション所有のGPUサーフェス(ビデオ、カスタム3D)はありません。検討中です。
始め方
新しいフォルダに main.go として以下をコピーしてください:
package main
import (
"fmt"
app "go.hasen.dev/shirei/app"
. "go.hasen.dev/shirei"
. "go.hasen.dev/shirei/widgets"
)
func main() {
app.SetupWindow("My App", 300, 100)
app.Run(RootView)
}
var count int
func RootView() {
Container(Attrs(Viewport, Background(220, 10, 97, 1)), func() {
Container(Attrs(Row, CrossMid, Pad(20), Gap(10)), func() {
Label(fmt.Sprintf("Counter: %d", count))
if Button(SymIPlus, "Increment") {
count++
}
})
})
}
次に以下を入力します:
$ go mod init main
$ go mod tidy
$ go run .
以下のようなウィンドウが表示されるはずです:
[画像: IncrementボタンがあるCounterウィンドウ]
ツール
コンパニオンCLIをインストールします(バイナリは $(go env GOPATH)/bin に配置されます。これを PATH に追加しておいてください):
go install go.hasen.dev/shirei/cmd/shirei_mobilerun@latest
go install go.hasen.dev/shirei/cmd/shirei_bundle@latest
| コマンド |
|---|
shirei_mobilerun |
shirei_bundle |
- モバイル開発セットアップ:docs/android.md, docs/ios.md
- バンドルの詳細:cmd/shirei_bundle/README.md
- Mobilerunの詳細:cmd/shirei_mobilerun/README.md
- アプリケーションリソース(
Resources/+app.ResourcePath):docs/resources.md
学習リソース
- チュートリアル
- レイアウトシェル(ステップバイステップ)
- 外観:カラーテーマ、ダークモード、ウィジェットスタイル
- カスタムウィジェットのアクセシビリティ
- オーディオ
- アプリリソース
- 仮想リストと測定
- コンテナの識別
- ドラッグアンドドロップ
- Androidでの実行 (
shirei_mobilerun) - iOSでの実行 (
shirei_mobilerun) - モバイル拡張/エスケープハッチ
- リリースパッケージング(
shirei_bundle)