Electron API 早見表と設定テンプレート
メインプロセス API 早見表
| モジュール |
機能説明 |
よく使うメソッド |
説明 |
| app |
アプリケーションのライフサイクルを制御 |
app.on('ready')、app.quit()、app.getPath('userData') |
アプリの起動・終了・パス・プロトコル登録などを管理 |
| BrowserWindow |
ウィンドウの作成と管理 |
new BrowserWindow(options)、win.loadFile()、win.loadURL()、win.webContents |
Electron アプリの主要な UI コンテナで、内部でレンダラープロセスが動作する |
| ipcMain |
メインプロセス通信インターフェース |
ipcMain.on(channel, callback)、ipcMain.handle(channel, handler) |
レンダラープロセスからのメッセージや呼び出しリクエストを監視する |
| Menu |
アプリケーションメニューの作成 |
Menu.buildFromTemplate(menuTemplate)、Menu.setApplicationMenu(menu) |
メニュー項目、ショートカットキー、右クリックメニューをカスタマイズ可能 |
| Tray |
システムトレイ管理 |
new Tray(icon)、tray.setToolTip()、tray.setContextMenu(menu) |
タスクバーにアイコンを表示。バックグラウンド常駐アプリによく使われる |
| Dialog |
システム標準ダイアログ |
dialog.showOpenDialog()、dialog.showSaveDialog()、dialog.showMessageBox() |
ファイル選択、保存、メッセージ表示などのシステム操作 |
| Notification |
システム通知 |
new Notification({ title, body }).show() |
システム標準通知を送信。クリックコールバック付き |
| Shell |
システム外部リソースの呼び出し |
shell.openExternal(url)、shell.showItemInFolder(path) |
外部Webページやフォルダを開く、ファイルを実行する |
| Protocol |
カスタムプロトコルの登録 |
protocol.registerFileProtocol()、protocol.handle() |
カスタムリソースの読み込みやディープリンクに使用 |
| Session |
セッション、キャッシュ、Cookieの管理 |
session.defaultSession.cookies.get()、clearCache() |
ブラウジングデータとリクエストを低レベルで制御 |
| Net |
ネイティブ HTTP/HTTPS ネットワークリクエスト |
net.request(options) |
より低レベルなネットワークモジュールで、パフォーマンスが優れているfetch |
| PowerMonitor |
システムの電源状態を監視 |
powerMonitor.on('suspend')、on('resume') |
PCのスリープ、復帰、ロックなどの状態を監視 |
| Clipboard |
クリップボード操作 |
clipboard.readText()、clipboard.writeText() |
クロスプラットフォームでテキストや画像などのコピー&ペーストに対応 |
| GlobalShortcut |
グローバルショートカットキーの登録 |
globalShortcut.register('CommandOrControl+X', fn) |
ウィンドウをまたぎ、バックグラウンドで有効なショートカットキー |
レンダラープロセス API 早見表
| モジュール |
機能説明 |
よく使うメソッド |
説明 |
| ipcRenderer |
メインプロセスとの通信 |
ipcRenderer.send()、ipcRenderer.invoke()、ipcRenderer.on() |
レンダラープロセスがメインプロセスのイベントを送信・受信・呼び出しするために使用 |
| webFrame |
現在のページコンテンツの制御 |
webFrame.setZoomFactor()、webFrame.insertCSS() |
ページのズームやスタイルを動的に変更 |
| contextBridge |
APIを安全に公開 |
contextBridge.exposeInMainWorld('api', {...}) |
有効にするとcontextIsolation安全にメインプロセスとやり取りできる |
| desktopCapturer |
画面コンテンツのキャプチャ |
desktopCapturer.getSources({ types: ['window', 'screen'] }) |
スクリーンショットや画面録画機能に使用 |
| Notification |
通知 API |
new Notification('标题', { body: '内容' }) |
ブラウザ標準の Notification を使って通知を送信 |
| Clipboard |
クリップボード操作 |
navigator.clipboard.readText() |
システムクリップボードにアクセス可能(一部機能は制限あり) |
| Web Storage / IndexedDB |
ローカルストレージ |
localStorage.setItem()、indexedDB.open() |
軽量または構造化データを保存 |
| Fetch / Axios |
ネットワークリクエスト |
fetch(url)、axios.get() |
リモートAPIへのアクセスやリソースの読み込みに使用 |
| DOM / Window |
ページ制御 |
document.querySelector()、window.open() |
すべての Web API が使用可能 |
よく使う補助モジュール早見表
| モジュール |
主な機能 |
例 |
| fs |
ファイル操作 |
fs.readFileSync(path)、fs.writeFile(path, data) |
| path |
パス結合 |
path.join(__dirname, 'index.html') |
| os |
システム情報 |
os.platform()、os.homedir() |
| child_process |
子プロセスの実行 |
exec('ls', callback) |
| electron-store |
永続化設定 |
store.set('key', value)、store.get('key') |
| sqlite3 / better-sqlite3 |
ローカルデータベース |
db.prepare('SELECT * FROM notes').all() |
| axios / node-fetch |
ネットワークリクエスト |
axios.post(url, data) |
| node-gyp |
ネイティブモジュールのコンパイル |
node-gyp rebuild |
設定ファイルのテンプレートと説明
package.json テンプレートと説明
{
"name": "my-electron-app",
"version": "1.0.0",
"description": "示例 Electron 应用",
"main": "main.js",
"scripts": {
"start": "electron .",
"pack": "electron-builder --dir",
"dist": "electron-builder"
},
"devDependencies": {
"electron": "^33.0.0",
"electron-builder": "^24.6.0"
},
"build": {
"appId": "com.example.myelectronapp",
"productName": "MyElectronApp",
"directories": {
"output": "dist"
},
"files": [
"main.js",
"preload.js",
"renderer/**/*"
],
"win": {
"target": "nsis",
"icon": "assets/icon.ico"
},
"mac": {
"category": "public.app-category.productivity",
"icon": "assets/icon.icns"
},
"linux": {
"target": "AppImage",
"icon": "assets/"
}
}
}
説明:
| フィールド |
意味 |
| name / version / description |
アプリ名、バージョン番号、説明情報 |
| main |
メインプロセスエントリファイル(必須) |
| scripts |
コマンドスクリプトを定義し、npm start起動、npm run distパッケージ化 |
| devDependencies |
開発依存関係(Electron、パッケージ化ツールなど) |
| build |
electron-builderの設定項目 |
| appId |
アプリの一意のID。署名と更新の識別に使用 |
| productName |
パッケージ化後に表示されるアプリ名 |
| directories.output |
パッケージ化の出力パス |
| files |
アプリにパッケージ化するファイルとディレクトリを指定 |
| win/mac/linux |
各プラットフォームの個別パッケージ設定(アイコン、ターゲット形式) |
electron-builder.yml テンプレートと説明
appId: com.example.myelectronapp
productName: MyElectronApp
directories:
output: dist
files:
- "main.js"
- "preload.js"
- "renderer/**/*"
win:
target: nsis
icon: assets/icon.ico
mac:
target: dmg
icon: assets/icon.icns
linux:
target: AppImage
icon: assets/
publish:
provider: github
repo: my-electron-app
owner: username
説明:
| 設定項目 |
説明 |
| appId / productName |
アプリの一意の識別子と名前 |
| directories.output |
パッケージ化の出力ディレクトリ |
| files |
パッケージ化するファイルリスト(ワイルドカード対応) |
| win / mac / linux |
各OSのビルドターゲットとアイコン設定 |
| publish |
自動更新時のリリースソース設定(例: GitHub Releases) |
TypeScript tsconfig.json テンプレートと説明
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"strict": true,
"outDir": "./dist",
"rootDir": "./src",
"esModuleInterop": true,
"moduleResolution": "node",
"resolveJsonModule": true,
"skipLibCheck": true
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
説明:
| オプション |
意味 |
| target |
コンパイル対象の JavaScript バージョン |
| module |
モジュールシステム。Electron メインプロセスでは通常commonjs |
| outDir / rootDir |
出力ディレクトリとソースディレクトリ |
| strict |
厳格な型チェックを有効化 |
| esModuleInterop |
非ESモジュールのデフォルトインポートを許可 |
| resolveJsonModule |
JSONファイルのインポートをサポート |
| skipLibCheck |
型定義ファイルのチェックをスキップしてコンパイルを高速化 |
その他の拡張