From f63edc4f252d6c6c0e4649c1036f5b7457bee671 Mon Sep 17 00:00:00 2001 From: "electron-website-docs-updater[bot]" <166660481+electron-website-docs-updater[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 18:29:27 +0000 Subject: [PATCH] =?UTF-8?q?chore:=20update=20ref=20to=20docs=20(?= =?UTF-8?q?=F0=9F=A4=96)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/latest/.sha | 2 +- docs/latest/api/app.md | 13 +++++++++++++ docs/latest/api/safe-storage.md | 7 ++++++- docs/latest/faq.md | 9 +++++---- 4 files changed, 25 insertions(+), 6 deletions(-) diff --git a/docs/latest/.sha b/docs/latest/.sha index 780d1af46..53852cb66 100644 --- a/docs/latest/.sha +++ b/docs/latest/.sha @@ -1 +1 @@ -86ce4b4b9d015432e5a52e39fab740dc88e545fc \ No newline at end of file +76b7ac4e15c6492189a002215e3eeecf7157af48 \ No newline at end of file diff --git a/docs/latest/api/app.md b/docs/latest/api/app.md index 934dfd873..8b0ba7350 100644 --- a/docs/latest/api/app.md +++ b/docs/latest/api/app.md @@ -712,6 +712,19 @@ Overrides the current application's name. > [!NOTE] > This function overrides the name used internally by Electron; it does not affect the name that the OS uses. +### `app.setDesktopName(name)` _Linux_ + +* `name` string - The `.desktop` filename (e.g. `'my-app.desktop'`). + +Sets the [`.desktop` filename](https://specifications.freedesktop.org/desktop-entry/latest/file-naming.html) on Linux. +This should match the base filename of the app's installed `.desktop` file. The `.desktop` suffix is optional. + +This value is used to determine the default XDG application ID on Wayland and `WM_CLASS` on X11. If it is not set, +Electron will attempt to infer a name, but it may not match the packaged app's actual `.desktop` file. This could result +in the app showing a generic icon or failing to respond to global keyboard shortcuts. + +This API must be called before the `ready` event. The value can also be set using `desktopName` in `package.json`. + ### `app.getLocale()` Returns `string` - The current application locale, fetched using Chromium's `l10n_util` library. diff --git a/docs/latest/api/safe-storage.md b/docs/latest/api/safe-storage.md index da80b2d1c..f591c0fe2 100644 --- a/docs/latest/api/safe-storage.md +++ b/docs/latest/api/safe-storage.md @@ -66,7 +66,12 @@ On Windows, returns true once the app has emitted the `ready` event. ### `safeStorage.isAsyncEncryptionAvailable()` -Returns `Promise` - Whether encryption is available for asynchronous safeStorage operations. +Returns `Promise` - Resolves with whether encryption is available for +asynchronous safeStorage operations. + +The asynchronous encryptor is initialized lazily the first time this method, +`encryptStringAsync`, or `decryptStringAsync` is called after the app is ready. +The returned promise resolves once initialization completes. ### `safeStorage.encryptString(plainText)` diff --git a/docs/latest/faq.md b/docs/latest/faq.md index 00dd57807..c7958761f 100644 --- a/docs/latest/faq.md +++ b/docs/latest/faq.md @@ -27,11 +27,12 @@ the [Advanced Installation](./tutorial/installation.md) documentation for more d ## How are Electron binaries downloaded? -When you run `npm install electron`, the Electron binary for the corresponding version is downloaded -into your project's `node_modules` folder via npm's `postinstall` lifecycle script. +When you run `npm install electron`, the main `bin` script is downloaded. +Once this is run (for example, via `npx electron`), the Electron binary for the corresponding version is downloaded into your project's node_modules folder dynamically via the `install-electron` script. -This logic is handled by the [`@electron/get`](https://github.com/electron/get) utility package -under the hood. +The download logic is handled by the [`@electron/get`](https://github.com/electron/get) utility package under the hood. + +You can also call the `install-electron` script manually. ## When will Electron upgrade to latest Chromium?