API リファレンス

このリファレンスについて

これは Wails v3 の完全な API リファレンスです。フレームワークで利用できるすべての公開型、メソッド、オプションについて説明します。

構成：

• アプリケーション - アプリケーションのコア API
• ウィンドウ - ウィンドウの作成と管理
• メニュー - アプリケーションメニュー、コンテキストメニュー、システムトレイメニュー
• イベント - イベントシステムと組み込みイベント
• ダイアログ - ファイルダイアログとメッセージダイアログ
• フロントエンドランタイム - フロントエンドランタイム API
• CLI - コマンドラインインターフェース

API の規約

if err := app.Run(); err != nil {
    log.Fatal(err)
}

func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error {
    // ctx is cancelled when the application is shutting down.
    return nil
}

app := application.New(application.Options{
    Name: "My App",
    Description: "A demo application",
    Services: []application.Service{
        application.NewService(&MyService{}),
    },
})

JavaScript API の規約

命名規則

• 関数：camelCase（例：setTitle()）
• 定数：SCREAMINGSNAKECASE（例：WINDOW_EVENT_FOCUS）

デフォルトで非同期

すべての Go メソッド呼び出しは Promise を返します。

// Async/await (recommended)
const result = await MyService.DoSomething()

// Promise chain
MyService.DoSomething()
    .then(result => console.log(result))
    .catch(error => console.error(error))

エラー処理

Go のエラーは JavaScript の例外になります。

try {
    await MyService.MightFail()
} catch (error) {
    console.error('Go error:', error)
}

型安全性

TypeScript の型定義は自動生成されます。

// Fully typed
import { Greet } from './bindings/GreetService'

const message: string = await Greet("World")

パッケージ構成

github.com/wailsapp/wails/v3/pkg/
├── application/          # Core application package
│   ├── application.go    # App type
│   ├── webview_window.go # Window management
│   ├── menu.go           # Menu types
│   ├── event_manager.go  # Event system
│   └── dialogs.go        # Dialog APIs
├── events/               # Event constants
└── services/             # Built-in services
    ├── dock/             # macOS dock (includes badge support)
    ├── fileserver/       # File-server service
    ├── kvstore/          # Key/value store
    ├── log/              # Structured logging service
    ├── notifications/    # Notifications service
    └── sqlite/           # SQLite service

インポートパス

Go

import (
    "github.com/wailsapp/wails/v3/pkg/application"
    "github.com/wailsapp/wails/v3/pkg/events"
)

JavaScript

// Auto-generated bindings
import { MyMethod } from './bindings/MyService'

// Runtime APIs
import { Events, Window } from '@wailsio/runtime'

型リファレンス

共通の型

// Application
type App struct { /* ... */ }
type Options struct { /* ... */ }

// Window
type WebviewWindow struct { /* ... */ } // implements the Window interface
type WebviewWindowOptions struct { /* ... */ }

// Menu
type Menu struct { /* ... */ }
type MenuItem struct { /* ... */ }

// Events — there is no generic Event type; events are typed by source.
type ApplicationEvent struct { /* ... */ }
type WindowEvent struct { /* ... */ }
type CustomEvent struct { /* ... */ }
type EventListener struct { /* ... */ }

// Dialogs
type OpenFileDialogOptions struct { /* ... */ }
type SaveFileDialogOptions struct { /* ... */ }

// Window runtime
interface WindowOptions {
    title?: string
    width?: number
    height?: number
    // ...
}

// Events
type EventCallback = (data: any) => void

// Bindings (auto-generated)
export function MyMethod(arg: string): Promise<string>

プラットフォームによる違い

一部の API は、プラットフォームによって動作が異なります。

プラットフォーム固有の動作については、各 API セクションで説明します。

バージョニング

Wails v3 はセマンティックバージョニングに従います。

• メジャー（v3.x.x）：破壊的変更
• マイナー（v3.x.x）：後方互換性のある新機能
• パッチ（v3.x.x）：後方互換性のあるバグ修正

現在のステータス：ベータ（API は安定、改良は継続中）

非推奨化ポリシー

API が非推奨になった場合：

1. ドキュメントに明記し、非推奨であることを通知
2. 代替手段を提示し、移行ガイドを提供
3. 削除前に1 メジャーバージョン分の期間は保守されます
4. コンパイラ警告（可能な場合）

API の安定性

安定版 API ✅

以下の API は安定しており、本番環境で安全に使用できます。

• コアアプリケーション API
• ウィンドウ管理
• メニューシステム
• イベントシステム
• ファイルダイアログ
• サービスバインディング

不安定版 API ⚠️

以下の API は正式リリースまでに変更される可能性があります。

• 一部の高度なウィンドウオプション
• プラットフォーム固有の機能
• 実験的機能

不安定版 API はドキュメントに明記されています。

ヘルプの利用

API に関する質問

1. このリファレンスを確認 — 完全な API ドキュメント
2. サンプルを確認 — GitHub のサンプル
3. Discord を検索 — Discord サーバー
4. コミュニティに質問 — Discord の #help チャンネル

API の問題の報告

バグや不整合を見つけましたか？

1. 既存の Issue を確認 — GitHub Issues
2. 詳細なレポートを作成 — コード、エラー、プラットフォームを含める
3. 再現手順を提示 — 問題を再現する最小限のサンプル

関連ドキュメント

• チュートリアル — 実際のアプリケーションを構築しながら学習
• ガイド — 一般的なシナリオ向けのタスク別ガイド
• 機能 — 機能ごとのドキュメント
• サンプル — GitHub 上の動作するコード例

API を参照：左側のナビゲーションを使用して、個々の API を確認できます。