menu | Casual Developers Note

[Tutorial][Electron] Electronで文章を話すアプリを作ってみよう #4 メニューバー実装編

最近はITの情報は全て英語で仕入れるようになりました。英語ができるからではありません。単純に新しいことをやろうとすると日本語の情報が少なすぎるからです。なので毎日英語の勉強を必ずしています。英語の勉強は時間のかかる戦いです。一度でも立ち止まってしまったら終わりです。「継続は力なり」という古い言葉を噛み締めています。皆さんはペラペラですか？

前回までで「文章を話すデスクトップアプリ」の機能は全て作り終えました。ただ、まだこのデスクトップアプリを世の中に出すには問題がいくつかあります。今回はその一つであるメニューバーをカスタマイズしてみましょう。

前回のおさらい

インスタントコーヒーのような味気ない人生より選択を楽む人生にしよう
Web Speech APIを使えば文章を読み上げる機能が作れる
WebのライブラリやAPIはElectronでは大抵使える

1. メニューバーのカスタマイズ

1-1. メニューバーとは？

デスクトップアプリのメニューバーと言ってイメージできますか？そうです、アプリを起動している時に左上にあるメニューのことです。

前回までのアプリを起動していみると、メニューバーはデフォルトのままなので、以下のようになっています。

これじゃ、いくらなんでも誰かにアプリを提供できません。なので、メニューバーをカスタマイズする必要があるわけです。

1-2. ドキュメントを読んでみよう

ElectronではMenuオブジェクトを使ってメニューバーのカスタマイズを行います。以下のドキュメントに軽く目を通して下さい。

2. コーディングしよう！

それではメニューバーをカスタマイズしていきましょう。

2-1. 独自メニューバーを作る

今回はデフォルトのメニューバーを無効化した上で、簡単にアプリが終了できるようにQuitのメニューをメニューバーに追加してみましょう。

いつも通りまずはフォルダ構成を確認します。

$ cd speak-sentences
$ ls
index.html         index.js           input.html         node_modules/      package-lock.json  package.json

変更するファイルはindex.jsだけです。以下のコードを追加しましょう。

index.jsに変更・追加する部分

const { app, BrowserWindow, ipcMain, Menu } = electron;

app.on("ready", () => {
  mainWindow = new BrowserWindow({
    width: 500,
    height: 500
  });
  mainWindow.loadURL(`file://${__dirname}/index.html`);
  mainWindow.on("closed", () => app.quit());
  // Menu
  const mainMenu = Menu.buildFromTemplate(menuTemplate);
  Menu.setApplicationMenu(mainMenu);
});

// Menu
const menuTemplate = [
  {
    label: "Menu",
    submenu: [
      {
        label: "Quit",
        accelerator: process.platform === "darwin" ? "Command+Q" : "Ctrl+Q",
        click() {
          app.quit();
        }
      }
    ]
  }
];

MenuオブジェクトのbuildFromTemplateを使い、Javascriptオブジェクトの配列として書いたメニューから、カスタマイズされたメニューバーを生成して登録しています。Command+Qで終了するようにショートカットも設定しています。

2-2. 開発者用メニューバーを作る

先程の独自メニューバーには開発する上で問題があります。Webデザイナかフロントエンジニアならすぐに気づいたと思いますが、Command+Alt+Iが効かないのです。プロダクションとしてはそれで良いですが、開発する場合は困ってしまいます。ということで、Developメニューを追加しましょう。

以下をindex.jsに追記します。

// Show Developer Tools
if (process.env.NODE_ENV === "development") {
  menuTemplate.push({
    label: "Develop",
    submenu: [
      {
        label: "Developer Tools",
        accelerator:
          process.platform === "darwin" ? "Command+Alt+I" : "Ctrl+Shift+I",
        click(item, focusedWindow) {
          focusedWindow.toggleDevTools();
        }
      }
    ]
  });
}

NodeJSの環境変数であるprocess.env.NODE_ENVに応じて、プロダクション版か開発者版かを切り替えるようにしています。

2-3. 必要に応じてメニューバーを調整する

ここまででメニューのカスタマイズは完成しています。あとは好みの問題だとは思いますが、Macの場合はメニューテンプレートの一番最初のラベルがアプリケーションのラベルと重なってしまい見えません。これをわかった上で今回は作っているので問題ありませんが、ズラして表示したい場合は以下のコードを追加しましょう。

同様にindex.jsに以下を追加するとメニューバーのラベルが全て見えるようになります。

if (process.platform === "darwin") {
  menuTemplate.unshift({});
}

これを設定すると、以下になっていたものが。

以下のようになります。

Macの場合、だいたいアプリ名の下にメニューがありますから、この動きを前提に作った方が個人的には自然な気がします。これはお好みで。

2-4. 開発者版とプロダクション版でコマンドを分ける

NodeJSでは当たり前ですが、process.env.NODE_ENVによって動きを分けているので、コマンドも分けます。

以下のようにpackage.jsonのscriptsを変更しましょう。

  "scripts": {
    "electron": "NODE_ENV=development electron .",
    "production": "NODE_ENV=production electron ."
  },

2-5. 全体のソースコード(今回編集分)

今回編集したソースコードの全体は以下です。

index.js

const electron = require("electron");

const { app, BrowserWindow, ipcMain, Menu } = electron;

let mainWindow;
let inputWindow;

app.on("ready", () => {
  mainWindow = new BrowserWindow({
    width: 500,
    height: 500
  });
  mainWindow.loadURL(`file://${__dirname}/index.html`);
  mainWindow.on("closed", () => app.quit());
  // Menu
  const mainMenu = Menu.buildFromTemplate(menuTemplate);
  Menu.setApplicationMenu(mainMenu);
});

function createInputWindow() {
  inputWindow = new BrowserWindow({
    width: 300,
    height: 300
  });
  inputWindow.loadURL(`file://${__dirname}/input.html`);
  inputWindow.on("closed", () => (inputWindow = null));
}

// Create a input window.
ipcMain.on("inputWindow:create", event => {
  createInputWindow();
});

// Send a sentence to a main window.
ipcMain.on("sentence:insert", (event, sentence) => {
  mainWindow.webContents.send("sentence:insert", sentence);
  inputWindow.close();
});

// Menu
const menuTemplate = [
  {
    label: "Menu",
    submenu: [
      {
        label: "Quit",
        accelerator: process.platform === "darwin" ? "Command+Q" : "Ctrl+Q",
        click() {
          app.quit();
        }
      }
    ]
  }
];

// Show Developer Tools
if (process.env.NODE_ENV === "development") {
  menuTemplate.push({
    label: "Develop",
    submenu: [
      {
        label: "Developer Tools",
        accelerator:
          process.platform === "darwin" ? "Command+Alt+I" : "Ctrl+Shift+I",
        click(item, focusedWindow) {
          focusedWindow.toggleDevTools();
        }
      }
    ]
  });
}

package.json

{
  "name": "speak-sentences",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "electron": "NODE_ENV=development electron .",
    "production": "NODE_ENV=production electron ."
  },
  "keywords": [],
  "author": "Keid",
  "license": "MIT",
  "dependencies": {
    "electron": "^1.7.6"
  }
}