跳到主要內容

WebPreferences 物件

  • devTools boolean (選填) - 是否啟用 DevTools。如果設定為 false,則無法使用 BrowserWindow.webContents.openDevTools() 開啟 DevTools。預設值為 true
  • nodeIntegration boolean (選填) - 是否啟用 Node.js 整合。預設值為 false
  • nodeIntegrationInWorker boolean (選填) - 是否在 Web Worker 中啟用 Node.js 整合。預設值為 false。更多相關資訊請參閱 多執行緒
  • nodeIntegrationInSubFrames boolean (選填) - 實驗性選項,用於在子框架(例如 iframes 和子視窗)中啟用 Node.js 支援。您的所有預載腳本都將為每個 iframe 加載,您可以使用 process.isMainFrame 來判斷您是否在主框架中。
  • preload string (選填) - 指定一個腳本,該腳本將在頁面中其他腳本執行之前載入。無論 Node.js 整合是否開啟,此腳本始終可以存取 Node.js API。值應為腳本的絕對檔案路徑。當 Node.js 整合關閉時,預載腳本可以將 Node.js 全域符號重新引入到全域作用域。請參閱此處的範例:這裡
  • sandbox boolean (選填) - 如果設定,這將沙盒化與視窗關聯的渲染器,使其與 Chromium OS 層級沙盒相容,並停用 Node.js 引擎。這與 nodeIntegration 選項不同,並且預載腳本可用的 API 更受限制。請在此處閱讀有關此選項的更多資訊:這裡
  • session Session (選填) - 設定頁面使用的 session。除了直接傳遞 Session 物件之外,您也可以選擇使用 partition 選項,該選項接受分割區字串。當同時提供 sessionpartition 時,將優先使用 session。預設值為預設 session。
  • partition string (選填) - 根據 session 的分割區字串,設定頁面使用的 session。如果 partitionpersist: 開頭,則頁面將使用持久性 session,該 session 可供應用程式中具有相同 partition 的所有頁面使用。如果沒有 persist: 前綴,則頁面將使用記憶體內 session。透過指定相同的 partition,多個頁面可以共享相同的 session。預設值為預設 session。
  • zoomFactor number (選填) - 頁面的預設縮放比例,3.0 代表 300%。預設值為 1.0
  • javascript boolean (選填) - 啟用 JavaScript 支援。預設值為 true
  • webSecurity boolean (選填) - 當為 false 時,它將停用同源政策(通常用於人們測試網站),並且如果使用者未設定此選項,則將 allowRunningInsecureContent 設定為 true。預設值為 true
  • allowRunningInsecureContent boolean (選填) - 允許 https 頁面從 http URL 執行 JavaScript、CSS 或外掛程式。預設值為 false
  • images boolean (選填) - 啟用圖片支援。預設值為 true
  • imageAnimationPolicy string (選填) - 指定如何執行圖片動畫(例如 GIF)。可以是 animateanimateOncenoAnimation。預設值為 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 中顯示的至少一個 webContents 停用 backgroundThrottling 時,將會為整個視窗及其顯示的其他 webContents 繪製和交換影格。預設值為 true
  • offscreen Object | boolean (選填) - 是否為瀏覽器視窗啟用離屏渲染。預設值為 false。請參閱 離屏渲染教學 以取得更多詳細資訊。
    • useSharedTexture boolean (選填) 實驗性 - 是否使用 GPU 共享紋理來加速繪製事件。預設值為 false。請參閱 離屏渲染教學 以取得更多詳細資訊。
  • contextIsolation boolean (選填) - 是否在獨立的 JavaScript 環境中執行 Electron API 和指定的 preload 腳本。預設值為 truepreload 腳本在其中執行的環境將僅能存取其自身的專用 documentwindow 全域變數,以及其自身的一組 JavaScript 內建物件 (ArrayObjectJSON 等),這些物件對於已載入的內容都是不可見的。Electron API 將僅在 preload 腳本中可用,而不在已載入的頁面中。當載入可能不受信任的遠端內容時,應使用此選項以確保已載入的內容無法竄改 preload 腳本和任何正在使用的 Electron API。此選項使用與 Chrome Content Scripts 相同的技術。您可以在開發人員工具中選取 Console 標籤頂部組合框中的「Electron Isolated Context」項目來存取此環境。
  • webviewTag boolean (選填) - 是否啟用 <webview> 標籤。預設值為 false注意:<webview> 配置的 preload 腳本在執行時將啟用 Node.js 整合,因此您應確保遠端/不受信任的內容無法建立具有可能惡意 preload 腳本的 <webview> 標籤。您可以使用 webContents 上的 will-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 (選填) - 是否啟用偏好大小模式。偏好大小是包含文件版面配置所需的最小大小 — 無需滾動。啟用此功能將導致在偏好大小變更時,在 WebContents 上發出 preferred-size-changed 事件。預設值為 false
  • transparent boolean (選填) - 是否為訪客頁面啟用背景透明度。預設值為 true注意: 訪客頁面的文字和背景顏色源自其根元素的 色彩配置。啟用透明度後,文字顏色仍會相應變更,但背景將保持透明。
  • enableDeprecatedPaste boolean (選填) 已棄用 - 是否啟用 paste execCommand。預設值為 false