Developing apps with React & Electron

Slide 1

Slide 1 text

Developing desktop apps with React & Electron Radoslav Stankov 28/08/2020

Slide 2

Slide 2 text

Radoslav Stankov @rstankov blog.rstankov.com  twitter.com/rstankov  github.com/rstankov  speakerdeck.com/rstankov

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

https://speakerdeck.com/rstankov

Slide 6

Slide 6 text

https://github.com/RStankov/FocusedTask

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

(main) (render)

Slide 15

Slide 15 text

(main)

Slide 16

Slide 16 text

(main) (render) rpc

Slide 17

Slide 17 text

(main) (render) rpc

Slide 18

Slide 18 text

const electron = window.require('electron') function closeApp() { electron.remote.getCurrentWindow().close(); } (render)

Slide 19

Slide 19 text

const electron = window.require('electron') electron.ipcRenderer.send('event', arg1, arg2); (render)

Slide 20

Slide 20 text

const electron = require('electron'); electron.ipcMain.on('event', function(_e, arg1, arg) { // ... }); (main)

Slide 21

Slide 21 text

No content

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

Focused Task https://github.com/RStankov/FocusedTask

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

! Tech Stack

Slide 29

Slide 29 text

! Tech Stack

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

No content

Slide 32

Slide 32 text

3 package.json! "

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

shell/package.json app/package.json ./package.json distribution (shell) (app)

Slide 35

Slide 35 text

https://github.com/maxogden/menubar

Slide 36

Slide 36 text

const { menubar } = require('menubar'); const electron = require('electron'); const mb = menubar({ index: process.env.ELECTRON_START_URL || url.format({ pathname: path.join(__dirname, './build/index.html'), protocol: 'file:', slashes: true, }), icon: path.join(__dirname, 'assets/MenuBarIconTemplate.png'), browserWindow: { width: 500, height: 600, minWidth: 300, maxHeight: 900, minHeight: 600, webPreferences: { nodeIntegration: true, scrollBounce: true, }, }, }); mb.on('after-create-window', () => { // ... });

Slide 37

Slide 37 text

Slide 38

Slide 38 text

create-react-app

Slide 39

Slide 39 text

Development ./bin/react-start ELECTRON_START_URL=http://localhost:3000 ./bin/electron-start

Slide 40

Slide 40 text

Distribution ./bin/react-build ./bin/electron-package FocusedTask.app

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Access Electron via React

Slide 43

Slide 43 text

Access Electron via React

Slide 44

Slide 44 text

Access Electron via React

Slide 45

Slide 45 text

Access Electron via React

Slide 46

Slide 46 text

Open external links

Slide 47

Slide 47 text

Open external links mb.app.on('web-contents-created', (e, contents) => { const openExternal = (e, url) => { e.preventDefault(); electron.shell.openExternal(url); }; contents.on('new-window', openExternal); contents.on('will-navigate', (e, url) => { if (url !== contents.getURL()) { openExternal(e, url); } }); });

Slide 48

Slide 48 text

Open external links export function openURI(uri: string) { if (!isElectron) { return; } if (!isURI(uri)) { return; } if (isFilePathUri(uri)) { electron.remote.shell.openItem(uri); } else { electron.remote.shell.openExternal(uri); } }

Slide 49

Slide 49 text

Open external links import * as React from 'react'; import { openURI } from 'utils/electron'; interface IProps { children: React.ReactNode; href: string; className?: string; } export default function ExternalLink(props: IProps) { return ( { e.preventDefault(); openURI(props.href); }} {...props} /> ); }

Slide 50

Slide 50 text

Resize window to ﬁt content

Slide 51

Slide 51 text

Resize window to ﬁt content export function resizeBasedOnContent() { if (!isElectron) { return; } const bodyStyle = window.getComputedStyle(document.body) as any; const padding = parseInt(bodyStyle['margin-top'], 10) + parseInt(bodyStyle['margin-bottom'], 10) + parseInt(bodyStyle['padding-top'], 10) + parseInt(bodyStyle['padding-bottom'], 10); const observer = new ResizeObserver(() => { const height = Math.min(900, document.body.offsetHeight + padding); const bounds = electron.remote .getCurrentWindow() .webContents.getOwnerBrowserWindow() .getBounds(); if (bounds.height === height) { return; } electron.ipcRenderer.send('resize', bounds.width, height); }); observer.observe(document.body); }

Slide 52

Slide 52 text

Resize window to ﬁt content electron.ipcMain.on('resize', function(_e, width, height) { mb.window.setSize(width, height); });

Slide 53

Slide 53 text

Store window position

Slide 54

Slide 54 text

Store window position const settings = require('electron-settings'); const electron = require('electron'); const _ = require('lodash'); const BOUNDS_KEY = 'windowBounds'; module.exports = { setWindowBounds(menubar) { menubar.setOption('browserWindow', { ...menubar.getOption('browserWindow'), ...(settings.get(BOUNDS_KEY) || {}), }); }, trackWindowBounds(menubar) { const win = menubar.window; const handler = _.debounce(() => { menubar.setOption('browserWindow', { ...menubar.getOption('browserWindow'), ...win.getBounds(), }); settings.set(BOUNDS_KEY, win.getBounds()); }, 500); win.on('resize', handler); win.on('move', handler); }, };

Slide 55

Slide 55 text

Store window position mb.on('after-create-window', () => { settings.trackWindowBounds(mb); }); mb.app.on('ready', () => { settings.setWindowBounds(mb); });

Slide 56

Slide 56 text

Global shortcut

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

No content

Slide 59

Slide 59 text

Global shortcut export function getGlobalShortcutKey() { if (!isElectron) { return; } return electron.remote.getGlobal('globalShortcutKey'); } export function updateGlobalShortcutKey(key: string) { if (!isElectron) { return; } if (key.length !== 1) { return; } electron.ipcRenderer.send('updateGlobalShortcutKey', key); }

Slide 60

Slide 60 text

Global shortcut mb.app.on('ready', () => { settings.setGlobalShortcut(mb); }); mb.app.on('will-quit', () => { electron.globalShortcut.unregisterAll(); }); electron.ipcMain.on('updateGlobalShortcutKey', (_e, key) => { settings.updateGlobalShortcutKey(mb, key); });

Slide 61

Slide 61 text

Global shortcut const settings = require('electron-settings'); const electron = require('electron'); const _ = require('lodash'); module.exports = { setGlobalShortcut(menubar) { const key = settings.get(SHORTCUT_KEY) || "'"; global.globalShortcutKey = key; electron.globalShortcut.register(`CommandOrControl+${key}`, () => { if (menubar.window && menubar.window.isVisible()) { menubar.hideWindow(); } else { menubar.showWindow(); } }); }, updateGlobalShortcutKey(menubar, key) { settings.set(SHORTCUT_KEY, key); electron.globalShortcut.unregisterAll(); this.setGlobalShortcut(menubar); }, };

Slide 62

Slide 62 text

Changelog

Slide 63

Slide 63 text

No content

Slide 64

Slide 64 text

No content

Slide 65

Slide 65 text

Changelog import React from 'react'; import Stack from 'components/Stack'; import BackButton from 'components/BackButton'; import Title from 'components/Title'; import ReactMarkdown from 'react-markdown'; import styles from './styles.module.css'; import raw from 'raw.macro'; const markdown = raw('../../../../CHANGELOG.md').replace(/^# .*\n\n/, ''); export default function Shortcuts() { return ( <>

> ); }

Slide 66

Slide 66 text

Distribution

Slide 67

Slide 67 text

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

...payment was rejected [N] times $

Slide 71

Slide 71 text

...turns out you need a credit card %

Slide 72

Slide 72 text

Slide 73

Slide 73 text

const packager = require('electron-packager'); const setLanguages = require('electron-packager-languages'); const createZip = require('electron-installer-zip'); const version = require('../shell/package.json').version; const credentials = require('../credentials.json'); packager({ dir: './shell', overwrite: true, out: './dist', afterCopy: [setLanguages(['en', 'en_GB'])], productName: 'FocusedTask', productName: 'Focused Task', appBundleId: 'com.rstankov.focused-task', appCopyright: 'Copyright (C) 2020 Radoslav Stankov', appVersion: version, appCategoryType: 'public.app-category.productivity', icon: './assets/Icon.icns', osxSign: { identity: credentials.identity, 'hardened-runtime': true, entitlements: 'entitlements.plist', 'entitlements-inherit': 'entitlements.plist', 'signature-flags': 'library', }, osxNotarize: credentials.osxNotarize, });

Slide 74

Slide 74 text

Auto update

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

const autoUpdate = require('./utils/autoupdate'); // ... mb.app.on('ready', () => { // ... if (!isDev) { autoUpdate(); } });

Slide 77

Slide 77 text

https://github.com/RStankov/FocusedTask/blob/master/shell/utils/autoupdate.js

Slide 78

Slide 78 text

No content

Slide 79

Slide 79 text

Thanks ' https://speakerdeck.com/rstankov https://github.com/RStankov/FocusedTask (