Electron Desktop App Development · レッスン

シェル連携

Electronの`shell`モジュールを使い、OSの既定のアプリケーションで外部リンク、ファイル、ディレクトリを開く方法を学びます。

「シェル連携」はCoddyKit上の無料Electron Desktop App Developmentレッスンです。これはレッスン3/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはElectron Desktop App Development学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Electron Desktop App Developmentコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Intro to Shell Integration

Welcome to Shell Integration! In Electron, your desktop app can interact with the user's operating system (OS) in powerful ways.

This means opening external links, files, or even showing items in the OS file explorer, just like native apps do.

Meet the `shell` Module

Electron provides the built-in shell module to make these OS interactions easy and safe. It's available in both the main and renderer processes.

The shell module lets your app delegate tasks like opening URLs or files to the OS's default applications.

Opening External URLs

The most common use case is opening web links in the user's default browser. You can do this with shell.openExternal(url).

This is crucial for security: instead of rendering external web content inside your app, you hand it off to a trusted browser.

Code: Open an External Link

Here's how you can open an external URL. This code would typically be in your main.js or called from a preload script if triggered by the renderer.

Try running this example:

const { app, shell } = require('electron');

app.whenReady().then(() => {
  // In a real app, this would be triggered by a user action.
  // For this demo, it opens when the app is ready.
  shell.openExternal('https://www.electronjs.org/docs')
    .then(() => console.log('Opened Electron docs!'))
    .catch(err => console.error('Failed to open URL:', err));
  // A real Electron app would also create a BrowserWindow here.
});

Opening Local Files & Folders

Need to open a document, image, or even a directory from your app? Use shell.openPath(path).

This function attempts to open the given file or directory with the OS's default application for that file type.

Code: Open a Local File

This example creates a simple text file and then opens it using the OS's default text editor.

Try running this example:

const { app, shell } = require('electron');
const path = require('path');
const fs = require('fs');

app.whenReady().then(() => {
  const userDataPath = app.getPath('userData');
  const filePath = path.join(userDataPath, 'my-document.txt');

  // Create a dummy file for demonstration
  fs.writeFileSync(filePath, 'Hello from CoddyKit! This is your document.');

  shell.openPath(filePath)
    .then(() => console.log(`Opened: ${filePath}`))
    .catch(err => console.error(`Failed to open path: ${err}`));
});

Showing Items in Explorer/Finder

Sometimes you don't want to open a file, but just show where it is. shell.showItemInFolder(fullPath) does just that.

It reveals the specified file in the user's operating system file manager (e.g., File Explorer on Windows, Finder on macOS), and optionally selects it.

Code: Show Item in Folder

Let's create another file and then show its location to the user.

Try running this example:

const { app, shell } = require('electron');
const path = require('path');
const fs = require('fs');

app.whenReady().then(() => {
  const desktopPath = app.getPath('desktop');
  const fileToShowPath = path.join(desktopPath, 'coddykit_demo_file.txt');

  // Create a dummy file on the desktop
  fs.writeFileSync(fileToShowPath, 'Find me!');

  shell.showItemInFolder(fileToShowPath);
  console.log(`Showing item in folder: ${fileToShowPath}`);
});

Security & Best Practices

When using shell methods, especially with user-provided input, always consider security:

Validate URLs: Before calling openExternal(), ensure the URL is safe and intended.
Context Isolation: In the renderer process, use a preload script to expose only necessary shell functions securely.
Error Handling: Always include .catch() for promise-based methods like openExternal and openPath.

Quick Check on Shell

Which shell module method would you use to open a web link in the user's default browser?

Recap: Shell Integration

Great job! You've learned how Electron's shell module helps your app interact with the native OS:

shell.openExternal() for web links.
shell.openPath() for local files/folders.
shell.showItemInFolder() to reveal items in the file manager.

These methods provide a seamless and secure way to extend your app's functionality to the native environment.

よくある質問

「シェル連携」レッスンは無料ですか？

はい。「シェル連携」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Electron Desktop App Developmentコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Electron Desktop App Developmentコースには全4レッスンが含まれています。

「シェル連携」で何を学びますか？

Electronの`shell`モジュールを使い、OSの既定のアプリケーションで外部リンク、ファイル、ディレクトリを開く方法を学びます。ブラウザで直接実行するハンズオンコードでElectron Desktop App Developmentを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Electron Desktop App Developmentを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのElectron Desktop App Developmentは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン3/4です。

「シェル連携」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このElectron Desktop App Developmentレッスンでコードを書いて実行できますか？

はい。すべてのElectron Desktop App Developmentレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Electron Desktop App Developmentに戻る