Skip to content

Commit 6bf83e9

Browse files
authored
docs: note that shell can't be used in sandboxed renderers (electron#22974)
1 parent 468994b commit 6bf83e9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/api/shell.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Manage files and URLs using their default applications.
44
5-
Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
5+
Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process) (non-sandboxed only)
66

77
The `shell` module provides functions related to desktop integration.
88

@@ -14,6 +14,8 @@ const { shell } = require('electron')
1414
shell.openExternal('https://github.com')
1515
```
1616

17+
**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.
18+
1719
## Methods
1820

1921
The `shell` module has the following methods:

0 commit comments

Comments
 (0)