メインコンテンツにスキップ

WebPreferences オブジェクト

  • devTools boolean (オプション) - DevTools を有効にするかどうか。 false に設定すると、BrowserWindow.webContents.openDevTools() を使用して DevTools を開くことができません。デフォルトは true です。
  • nodeIntegration boolean (オプション) - Node インテグレーションを有効にするかどうか。デフォルトは false です。
  • nodeIntegrationInWorker boolean (オプション) - Web ワーカーで Node インテグレーションを有効にするかどうか。デフォルトは false です。詳細については、マルチスレッディング を参照してください。
  • nodeIntegrationInSubFrames boolean (オプション) - iframe や子ウィンドウなどのサブフレームで Node.js のサポートを有効にするための実験的なオプションです。すべてのプリロードはすべての iframe でロードされ、process.isMainFrame を使用してメインフレームにいるかどうかを判断できます。
  • preload string (オプション) - ページ内で他のスクリプトが実行される前にロードされるスクリプトを指定します。このスクリプトは、Node インテグレーションが有効になっているかどうかに関係なく、常に Node API にアクセスできます。値は、スクリプトへの絶対ファイルパスである必要があります。Node インテグレーションが無効になっている場合、プリロードスクリプトは Node グローバルシンボルをグローバルスコープに再導入できます。例については、こちらを参照してください。
  • sandbox boolean (オプション) - 設定すると、ウィンドウに関連付けられたレンダラーがサンドボックス化され、Chromium OS レベルのサンドボックスと互換性があり、Node.js エンジンが無効になります。これは nodeIntegration オプションと同じではなく、プリロードスクリプトで利用できる API はより制限されています。このオプションの詳細については、こちらを参照してください。
  • session Session (オプション) - ページで使用されるセッションを設定します。Session オブジェクトを直接渡す代わりに、パーティション文字列を受け入れる partition オプションを使用することもできます。sessionpartition の両方が指定されている場合、session が優先されます。デフォルトはデフォルトのセッションです。
  • partition string (オプション) - セッションのパーティション文字列に従って、ページで使用されるセッションを設定します。partitionpersist: で始まる場合、ページは、同じ partition を持つアプリ内のすべてのページで使用できる永続的なセッションを使用します。persist: プレフィックスがない場合、ページはインメモリセッションを使用します。同じ partition を割り当てることで、複数のページが同じセッションを共有できます。デフォルトはデフォルトのセッションです。
  • zoomFactor number (オプション) - ページのデフォルトのズームファクター。3.0300% を表します。デフォルトは 1.0 です。
  • javascript boolean (オプション) - JavaScript のサポートを有効にします。デフォルトは true です。
  • webSecurity boolean (オプション) - false の場合、同一オリジンポリシーが無効になり(通常はテスト用の Web サイトを使用するユーザーが対象)、このオプションがユーザーによって設定されていない場合は allowRunningInsecureContenttrue に設定されます。デフォルトは true です。
  • allowRunningInsecureContent boolean (オプション) - https ページで http URL からの JavaScript、CSS、またはプラグインの実行を許可します。デフォルトは false です。
  • images boolean (オプション) - 画像のサポートを有効にします。デフォルトは true です。
  • imageAnimationPolicy string (オプション) - 画像アニメーション(例:GIF)の実行方法を指定します。animateanimateOnce、または noAnimation を指定できます。デフォルトは animate です。
  • textAreasAreResizable boolean (オプション) - TextArea 要素をリサイズ可能にします。デフォルトは true です。
  • webgl boolean (オプション) - WebGL のサポートを有効にします。デフォルトは true です。
  • plugins boolean (オプション) - プラグインを有効にするかどうか。デフォルトは false です。
  • experimentalFeatures boolean (オプション) - Chromium の実験的機能を有効にします。デフォルトは false です。
  • scrollBounce boolean (オプション) macOS - macOS でスクロールバウンス (ゴムバンド) 効果を有効にします。デフォルトは false です。
  • enableBlinkFeatures string (オプション) - 有効にする機能文字列のリストを , で区切って指定します (例: CSSVariables,KeyboardEventKey)。サポートされている機能文字列の完全なリストは、RuntimeEnabledFeatures.json5 ファイルにあります。
  • disableBlinkFeatures string (オプション) - 無効にする機能文字列のリストを , で区切って指定します (例: CSSVariables,KeyboardEventKey)。サポートされている機能文字列の完全なリストは、RuntimeEnabledFeatures.json5 ファイルにあります。
  • defaultFontFamily Object (オプション) - フォントファミリーのデフォルトフォントを設定します。
    • standard string (オプション) - デフォルトは Times New Roman です。
    • serif string (オプション) - デフォルトは Times New Roman です。
    • sansSerif string (オプション) - デフォルトは Arial です。
    • monospace string (オプション) - デフォルトは Courier New です。
    • cursive string (オプション) - デフォルトは Script です。
    • fantasy string (オプション) - デフォルトは Impact です。
    • math string (オプション) - デフォルトは Latin Modern Math です。
  • defaultFontSize Integer (オプション) - デフォルトは 16 です。
  • defaultMonospaceFontSize Integer (オプション) - デフォルトは 13 です。
  • minimumFontSize Integer (オプション) - デフォルトは 0 です。
  • defaultEncoding string (オプション) - デフォルトは ISO-8859-1 です。
  • backgroundThrottling boolean (オプション) - ページがバックグラウンドになったときにアニメーションとタイマーをスロットルするかどうか。これは Page Visibility API にも影響します。単一の browserWindow に表示される少なくとも 1 つの webContentsbackgroundThrottling を無効にしている場合、フレームはウィンドウ全体と、それによって表示される他の webContents に対して描画およびスワップされます。デフォルトは true です。
  • offscreen boolean (オプション) - ブラウザウィンドウのオフスクリーンレンダリングを有効にするかどうか。デフォルトは false です。詳細については、オフスクリーンレンダリングのチュートリアルを参照してください。
  • contextIsolation boolean (オプション) - Electron APIと指定されたpreloadスクリプトを別のJavaScriptコンテキストで実行するかどうか。デフォルトはtrueです。preloadスクリプトが実行されるコンテキストは、専用のdocumentwindowグローバル、および独自のJavaScript組み込み(ArrayObjectJSONなど)のセットのみにアクセスでき、これらはすべてロードされたコンテンツからは見えません。Electron APIはpreloadスクリプト内でのみ利用可能で、ロードされたページでは利用できません。このオプションは、ロードされたコンテンツがpreloadスクリプトや使用されているElectron APIを改ざんできないようにするために、潜在的に信頼できないリモートコンテンツをロードする場合に使用する必要があります。このオプションは、Chrome Content Scriptsで使用されているのと同じ手法を使用します。開発ツールでこのコンテキストにアクセスするには、コンソールタブの上部にあるコンボボックスで「Electron Isolated Context」エントリを選択します。
  • webviewTag boolean (オプション) - <webview> タグを有効にするかどうか。デフォルトはfalseです。注: <webview>用に構成されたpreloadスクリプトは、実行時にnode統合が有効になるため、リモート/信頼できないコンテンツが、悪意のある可能性があるpreloadスクリプトを持つ<webview>タグを作成できないようにする必要があります。 webContentswill-attach-webviewイベントを使用すると、preloadスクリプトを取り除き、<webview>の初期設定を検証または変更できます。
  • additionalArguments string[] (オプション) - このアプリのレンダラープロセスでprocess.argvに追加される文字列のリスト。レンダラープロセスのプリロードスクリプトに少量のデータを渡すのに役立ちます。
  • safeDialogs boolean (オプション) - ブラウザースタイルの連続ダイアログ保護を有効にするかどうか。デフォルトはfalseです。
  • safeDialogsMessage string (オプション) - 連続ダイアログ保護がトリガーされたときに表示するメッセージ。定義されていない場合はデフォルトのメッセージが使用されます。現在のところ、デフォルトのメッセージは英語であり、ローカライズされていないことに注意してください。
  • disableDialogs boolean (オプション) - ダイアログを完全に無効にするかどうか。safeDialogsを上書きします。デフォルトはfalseです。
  • navigateOnDragDrop boolean (オプション) - ファイルまたはリンクをページにドラッグアンドドロップするとナビゲーションが発生するかどうか。デフォルトはfalseです。
  • autoplayPolicy string (オプション) - ウィンドウ内のコンテンツに適用する自動再生ポリシー。no-user-gesture-requireduser-gesture-requireddocument-user-activation-requiredを指定できます。デフォルトはno-user-gesture-requiredです。
  • disableHtmlFullscreenWindowResize boolean (オプション) - HTMLフルスクリーンに入るときにウィンドウのサイズ変更を防止するかどうか。デフォルトはfalseです。
  • accessibleTitle string (オプション) - スクリーンリーダーなどのアクセシビリティツールにのみ提供される代替タイトル文字列。この文字列はユーザーには直接表示されません。
  • spellcheck boolean (オプション) - ビルトインのスペルチェッカーを有効にするかどうか。デフォルトはtrueです。
  • enableWebSQL boolean (オプション) - WebSQL APIを有効にするかどうか。デフォルトはtrueです。
  • v8CacheOptions string (オプション) - blinkで使用されるv8コードキャッシュポリシーを強制します。受け入れられる値は次のとおりです。
    • none - コードキャッシュを無効にします
    • code - ヒューリスティックベースのコードキャッシュ
    • bypassHeatCheck - コードキャッシュヒューリスティックをバイパスしますが、遅延コンパイルを使用します
    • bypassHeatCheckAndEagerCompile - 上記と同様ですが、コンパイルは即時です。デフォルトポリシーはcodeです。
  • enablePreferredSizeMode boolean (オプション) - 推奨サイズモードを有効にするかどうか。推奨サイズとは、スクロールを必要とせずにドキュメントのレイアウトを含めるために必要な最小サイズです。これを有効にすると、推奨サイズが変更されたときにWebContentspreferred-size-changedイベントが発行されます。デフォルトはfalseです。
  • transparent boolean (オプション) - ゲストページの背景の透明度を有効にするかどうか。デフォルトはtrueです。注: ゲストページのテキストと背景色は、ルート要素のカラースキームから派生します。透明度が有効になっている場合、テキストの色はそれに応じて変更されますが、背景は透明のままになります。