ユーザーガイド

ReScript で Tauri 2.x デスクトップアプリを書き始めるために必要な情報を集めています。

はじめに

リファレンス

  • 設定rescript.json / peerDependencies / 互換マトリクス

  • 変更履歴 — リリースノート

モジュール一覧

@rescript-tauri/core は 12 個の Phase 1 モジュールに加え、よく使うインポートをまとめた Tauri アンブレラモジュールを提供します。各モジュールは専用の .resi を持ち、対応する Tauri 上流ドキュメントへのリンクを doc-comment に記載しています。

モジュール

用途

Tauri

open Tauri で再エクスポートされる 5 つの主要モジュール(Core / Event / Window / Webview / WebviewWindow)

Core

IPC ブリッジ — Raw.invoke / 型付き Command / ストリーミング Channel / convertFileSrc

Event

pub/sub イベントバス(make / listen / once / emit / emitTo

Window

Window クラス — 不透明ハンドル + 約 80 個のインスタンス / 静的メソッド、theme / cursorIcon / effects / monitor などフル型セット

Webview

Webview クラス — 不透明ハンドル + 14 個のインスタンスメソッド + ドラッグ & ドロップイベントの variant

WebviewWindow

Window と Webview を統合した API。ゼロコストの asWindow / asWebview キャストを提供

Menu

アプリケーションメニューの階層構造(MenuItem / CheckMenuItem / IconMenuItem / PredefinedMenuItem / Submenu / Menu

Tray

システムトレイアイコン(TrayIcon)とクリックイベントの variant

Path

パスユーティリティ — 31 個のヘルパー関数と BaseDirectory 列挙型

App

アプリケーションメタデータとライフサイクル(getName / getVersion / setTheme / defaultWindowIcon ほか)

Image

RGBA 画像の不透明ハンドル(fromPath / fromBytes / new_ / rgba / size

Dpi

DPI を考慮したサイズ・位置(LogicalSize / PhysicalSize / LogicalPosition / PhysicalPosition / Size / Position

Mocks

テスト用ヘルパー(mockIPC / mockWindows / clearMocks

アドオンパッケージ

core の上に乗る 9 個のアドオンパッケージがあります。いずれも独立して公開され、対応する上流のプラグイン / スキーマライブラリを peerDependencies 経由で取り込みます。

パッケージ

用途

ガイド

@rescript-tauri/plugin-fs

ファイルシステム操作(read / write / dir / stat)

plugin-fs

@rescript-tauri/plugin-dialog

ネイティブダイアログ(open / save / message / ask / confirm)

plugin-dialog

@rescript-tauri/plugin-notification

ネイティブ通知(toast / schedule / channels)

plugin-notification

@rescript-tauri/plugin-shell

子プロセスの起動、OS デフォルトアプリで URL / ファイルを開く

plugin-shell

@rescript-tauri/plugin-log

構造化ロギング(5 段階 + ログストリームリスナー)

plugin-log

@rescript-tauri/plugin-os

OS 情報(platform / arch / family / locale / hostname)

plugin-os

@rescript-tauri/plugin-clipboard-manager

クリップボードの読み書き(text / image / HTML)

plugin-clipboard-manager

@rescript-tauri/plugin-http

CORS をバイパスする HTTP fetch と proxy / TLS の設定

plugin-http

@rescript-tauri/schema

rescript-schema を用いた Layer 3 型付き IPC

schema