Skip to content

Commit d20ea38

Browse files
committed
docs: update usage examples
1 parent 1798b2a commit d20ea38

File tree

1 file changed

+55
-49
lines changed

1 file changed

+55
-49
lines changed

packages/electron-chrome-extensions/README.md

Lines changed: 55 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ Simple browser using Electron's [default session](https://www.electronjs.org/doc
2626

2727
```js
2828
const { app, BrowserWindow } = require('electron')
29-
const { ElectronChromeExtensions } = require('electron-chrome-extensions')(
30-
(async function main() {
31-
await app.whenReady()
29+
const { ElectronChromeExtensions } = require('electron-chrome-extensions')
30+
31+
app.whenReady().then(async () => {
32+
await app.whenReady()
3233

33-
const extensions = new ElectronChromeExtensions()
34-
const browserWindow = new BrowserWindow()
34+
const extensions = new ElectronChromeExtensions()
35+
const browserWindow = new BrowserWindow()
3536

36-
// Adds the active tab of the browser
37-
extensions.addTab(browserWindow.webContents, browserWindow)
37+
// Adds the active tab of the browser
38+
extensions.addTab(browserWindow.webContents, browserWindow)
3839

39-
browserWindow.loadURL('https://samuelmaddock.com')
40-
browserWindow.show()
41-
})(),
42-
)
40+
browserWindow.loadURL('https://samuelmaddock.com')
41+
browserWindow.show()
42+
})
4343
```
4444

4545
### Advanced
@@ -51,44 +51,50 @@ Multi-tab browser with full support for Chrome extension APIs.
5151
```js
5252
const { app, session, BrowserWindow } = require('electron')
5353
const { ElectronChromeExtensions } = require('electron-chrome-extensions')(
54-
(async function main() {
55-
await app.whenReady()
5654

57-
const browserSession = session.fromPartition('persist:custom')
58-
59-
const extensions = new ElectronChromeExtensions({
55+
app.whenReady().then(async () => {
56+
await app.whenReady()
57+
58+
const browserSession = session.fromPartition('persist:custom')
59+
60+
const extensions = new ElectronChromeExtensions({
61+
session: browserSession,
62+
createTab(details) {
63+
// Optionally implemented for chrome.tabs.create support
64+
},
65+
selectTab(tab, browserWindow) {
66+
// Optionally implemented for chrome.tabs.update support
67+
},
68+
removeTab(tab, browserWindow) {
69+
// Optionally implemented for chrome.tabs.remove support
70+
},
71+
createWindow(details) {
72+
// Optionally implemented for chrome.windows.create support
73+
},
74+
removeWindow(browserWindow) {
75+
// Optionally implemented for chrome.windows.remove support
76+
},
77+
requestPermissions(extension, permissions) {
78+
// Optionally implemented for chrome.permissions.request support
79+
},
80+
})
81+
82+
const browserWindow = new BrowserWindow({
83+
webPreferences: {
84+
// Same session given to Extensions class
6085
session: browserSession,
61-
createTab(details) {
62-
// Optionally implemented for chrome.tabs.create support
63-
},
64-
selectTab(tab, browserWindow) {
65-
// Optionally implemented for chrome.tabs.update support
66-
},
67-
removeTab(tab, browserWindow) {
68-
// Optionally implemented for chrome.tabs.remove support
69-
},
70-
createWindow(details) {
71-
// Optionally implemented for chrome.windows.create support
72-
},
73-
})
74-
75-
const browserWindow = new BrowserWindow({
76-
webPreferences: {
77-
// Same session given to Extensions class
78-
session: browserSession,
79-
// Recommended options for loading remote content
80-
sandbox: true,
81-
contextIsolation: true,
82-
},
83-
})
84-
85-
// Adds the active tab of the browser
86-
extensions.addTab(browserWindow.webContents, browserWindow)
87-
88-
browserWindow.loadURL('https://samuelmaddock.com')
89-
browserWindow.show()
90-
})(),
91-
)
86+
// Recommended options for loading remote content
87+
sandbox: true,
88+
contextIsolation: true,
89+
},
90+
})
91+
92+
// Adds the active tab of the browser
93+
extensions.addTab(browserWindow.webContents, browserWindow)
94+
95+
browserWindow.loadURL('https://samuelmaddock.com')
96+
browserWindow.show()
97+
})
9298
```
9399
94100
## API
@@ -176,7 +182,7 @@ supported URL types.
176182
177183
Example:
178184
179-
```
185+
```js
180186
{
181187
newtab: 'chrome-extension://<id>/newtab.html'
182188
}
@@ -421,7 +427,7 @@ See [Electron's Notification tutorial](https://www.electronjs.org/docs/tutorial/
421427
422428
### electron-chrome-extensions
423429
424-
- The latest version of Electron is recommended. Minimum support requires Electron v35.0.0-beta.3.
430+
- The latest version of Electron is recommended. Minimum support requires Electron v35.0.0-beta.8.
425431
- All background scripts are persistent.
426432
427433
### electron

0 commit comments

Comments
 (0)