docs: mention that webUtils should be used via preload script (#48454)

docs: mention that webUtils should be used via preload script (#45861)

* docs: mention that webUtils should be used via preload script

* docs: suppress lint errors

* docs: clarify webUtils usage scope

* docs: exclude potentially dangerous alert() in the example code

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: minor change

* docs: make linter happy

* docs: apply suggestion



* docs: apply suggestion



* docs: apply suggestion



* docs: minor change

* docs: minor change

* docs: remove preload line

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Kaiichiro Ota <kigh.ota@gmail.com>
This commit is contained in:
trop[bot] 2025-10-03 15:48:06 -05:00 committed by GitHub
commit 347fd37dfb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -17,11 +17,27 @@ Returns `string` - The file system path that this `File` object points to. In th
This method superseded the previous augmentation to the `File` object with the `path` property. An example is included below. This method superseded the previous augmentation to the `File` object with the `path` property. An example is included below.
```js @ts-nocheck ```js @ts-nocheck
// Before // Before (renderer)
const oldPath = document.querySelector('input').files[0].path const oldPath = document.querySelector('input[type=file]').files[0].path
```
// After
const { webUtils } = require('electron') ```js @ts-nocheck
// After
const newPath = webUtils.getPathForFile(document.querySelector('input').files[0])
// Renderer:
const file = document.querySelector('input[type=file]').files[0]
electronApi.doSomethingWithFile(file)
// Preload script:
const { contextBridge, webUtils } = require('electron')
contextBridge.exposeInMainWorld('electronApi', {
doSomethingWithFile (file) {
const path = webUtils.getPathForFile(file)
// Do something with the path, e.g., send it over IPC to the main process.
// It's best not to expose the full file path to the web content if possible.
}
})
``` ```