Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update notifications (renderer) docs #29566

Merged
merged 8 commits into from
Jun 7, 2021
Merged

docs: Update notifications (renderer) docs #29566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b57de7a
remove version information from html
codefoster May 20, 2021
8d2427c
change format for readability
codefoster May 20, 2021
e17d7a0
clarify which console the message should appear in
codefoster May 20, 2021
6ac8bf8
minor changes to renderer.md
codefoster May 20, 2021
995c334
update UI on click instead of developer console
codefoster May 21, 2021
2cb2a93
remove node-integration and fix md
Ethan-Arrowood Jun 3, 2021
ef2bf12
update content
Ethan-Arrowood Jun 3, 2021
2235e90
chore: remove ****
Jun 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/fiddles/features/notifications/renderer/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@
</head>
<body>
<h1>Hello World!</h1>
<p>
We are using node <script>document.write(process.versions.node)</script>,
Chrome <script>document.write(process.versions.chrome)</script>,
and Electron <script>document.write(process.versions.electron)</script>.
</p>
<p>After launching this application, you should see the system notification.</p>
<p id="output">Click it to see the effect in this interface.</p>

<script src="renderer.js"></script>
</body>
</html>
5 changes: 1 addition & 4 deletions docs/fiddles/features/notifications/renderer/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ const { app, BrowserWindow } = require('electron')
function createWindow () {
const win = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
nodeIntegration: true
}
height: 600
})

win.loadFile('index.html')
Expand Down
11 changes: 5 additions & 6 deletions docs/fiddles/features/notifications/renderer/renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
const myNotification = new Notification('Title', {
body: 'Notification from the Renderer process'
})
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY = 'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked!'

myNotification.onclick = () => {
console.log('Notification clicked')
}
new Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY })
.onclick = () => document.getElementById("output").innerText = CLICK_MESSAGE
20 changes: 8 additions & 12 deletions docs/tutorial/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,30 @@ To show notifications in the Main process, you need to use the

### Show notifications in the Renderer process

Assuming you have a working Electron application from the
Starting with a working application from the
[Quick Start Guide](quick-start.md), add the following line to the
`index.html` file before the closing `</body>` tag:

```html
<script src="renderer.js"></script>
```

and add the `renderer.js` file:
...and add the `renderer.js` file:

```javascript fiddle='docs/fiddles/features/notifications/renderer'
const myNotification = new Notification('Title', {
body: 'Notification from the Renderer process'
})
const NOTIFICATION_TITLE = 'Title'
const NOTIFICATION_BODY = 'Notification from the Renderer process. Click to log to console.'
const CLICK_MESSAGE = 'Notification clicked'

myNotification.onclick = () => {
console.log('Notification clicked')
}
new Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY })
.onclick = () => console.log(CLICK_MESSAGE)
```

After launching the Electron application, you should see the notification:

![Notification in the Renderer process](../images/notification-renderer.png)

If you open the Console and then click the notification, you will see the
message that was generated after triggering the `onclick` event:

![Onclick message for the notification](../images/message-notification-renderer.png)
Additionally, if you click on the notification, the DOM will update to show "Notification clicked!".

### Show notifications in the Main process

Expand Down