Electron in Action

Previous Chapter

Code from the end of chapter 6

List of Figures

Index

[SYMBOL][A][B][C][D][E][F][G][H][I][J][K][L][M][N][O][P][Q][R][S][T][U][V][W][X][Y]

SYMBOL

$ method $$ method

A

accelerator property add( ) method addClipping( ) function addEventListener addItem( ) method APIs (application programming interfaces) controlling with Spectron for native operating systems app.addRecentDocument( ) method app.client.getWindowCount( ) method app.client.waitUntilWindowLoaded( ) method app.getPath( ) function Application component applications bootstrapping displaying browser windows implementing UIs building for deployment importing Electron applications into Electron Forge using asar with Electron Forge with Electron Packager building for multiple operating systems building with menubar library adding clippings to UIs adding secondary menus displaying notifications publishing clippings registering global shortcuts clippings in preventing memory leaks using event delegation removing writing to clipboard configuring names in Electron Packager configuring versions in Electron Packager creating with tray module reading from clipboard and storing clippings supporting dark mode in macOS using correct icons for macOS and Windows debugging main processes renderer processes defining distributing through Mac App Store finishing touches uploading applications validating applications foundations for signing for macOS for Windows overview of starting with menubar submitting to Mac App Store adding applications to iTunes Connect configuring application categories packaging applications for Mac App Store registering applications to open file type registering applications with Mac App Store testing with Spectron overview of setting up setting up test runners WebdriverIO writing asynchronous tests updating automatically setting up automatic updates in Electron setting up servers for automatic updates updating icons in Electron Packager applications menus context menus vs disabling menu items dynamically enabling menu items dynamically foundations for shell module in Array.prototype.push( ) function Array.prototype.unshift( ) function asar archive format async keyword asynchronous tests, writing using Spectron controlling Electron APIs testing DOM testing Electron BrowserWindow APIs traversing DOM waiting for windows to load automatic updates setting up in Electron setting up servers for autoUpdater module, 2^nd autoUpdater.quitAndInstall( ) method await keyword

B

babel-preset-env base functionality bookmark list applications, building downloading Electron installing Electron package.json structuring Electron applications bootstrapping applications displaying browser windows implementing UIs box-sizing property Brave browser Breakpad brew install tree command Browserify browsers displaying windows vs menus, functionality in BrowserWindow APIs BrowserWindow module, 2^nd browserWindow.capturePage( ) method BrowserWindow.getFocusedWindow( ) function build command buildFromTemplate( ) method <button> element

C

certificateFile certificatePassword certificates CFBundleDocumentTypes CFBundleTypeExtensions CFBundleTypeRole Chrome Developer Tools Chromium Content Module click( ) method, 2^nd clipboard reading from handling edge cases overview of writing to, 2^nd Clipmaster clipboard manager clippings adding to UIs preventing memory leaks using event delegation publishing removing storing writing to clipboard code from renderer processes codesign command-line interface tool CommandOrControl shorthand common paths CommonJS require systems Component class configuring application categories application names in Electron Packager application versions in Electron Packager output directory in Electron Packager connection property content class context menus accessing shell module from application menus vs building disabling menu items dynamically in enabling menu items dynamically in convertToElement function crash reports collecting setting up crash reporter setting up servers to receive Crashpad createClippingElement( ) function createClippingMenuItem( ) function createContextMenu( ) function createWindow( ) function, 2^nd, 3^rd, 4^th cross-origin requests

D

dark mode in macOS darken( ) function data getting from IndexedDB storing in SQLite databases adding items to databases deleting items fetching all items from databases hooking databases into React setting up SQLite and Knex.js storing databases updating items in databases using right versions with electron-rebuild writing to IndexedDB databases adding items to connecting to UIs fetching items from hooking into React storing updating items in debugging applications main processes overview of with Visual Studio Code renderer processes default menus adding Help menus defining menu item roles and keyboard shortcuts Edit menus implementing missing implementing Window menus replacing restoring application menus on macOS default property delete( ) method, 2^nd dependencies deployment, building applications for importing Electron applications into Electron Forge using asar with Electron Forge with Electron Packager describe( ) method devDependencies Developer Program Member Center, Apple dialog module dialog sheets in macOS dialog.showErrorBox( ) function dialog.showMessageBox( ) function dialog.showOpenDialog( ) function dirname variable disabling menu items dynamically in application menus dynamically in context menus discarding changes to files DOM (Document Object Model) testing with Spectron traversing with Spectron DOMParser downloading Electron drag and drop, opening files with ignoring dropped files opening dropped files providing visual feedback .drag-error class .drag-over class dragover phase dropped files ignoring opening

E

ECMAScript classes edge cases handling when window has never been shown Edit menus implementing missing Electron advantages of access to native operating system APIs accessing Node from browser context building on existing skill sets enhanced privileges and looser restrictions offline first downloading installing NW.js vs overview of users of electron command-line tool Electron Forge building applications with importing Electron applications into overview of Electron Packager building for multiple operating systems configuring application name and version configuring output directory setting up updating application icons electron-compile, 2^nd electronPackagerConfig electron-positioner library electron-prebuilt package electron-rebuild, 2^nd electron.remote.getCurrentWindow( ) method enableLiveReload( ) method enabling menu items dynamically dynamically in context menus in application menus error handling event delegation exceptions, uncaught exporting rendered HTML output

F

Fetch API fetch variable FFmpeg library file structure filePath variable, 2^nd, 3^rd files keeping track of current file determining whether current file has changed enabling Save and Revert buttons in UI updating represented file on macOS updating window titles based on current file opening with drag and drop ignoring dropped files opening dropped files providing visual feedback promptings user before discarding changes to reading using Node implementing dialog sheets in macOS scoping Open File dialogs recently opened, tracking requiring in renderer processes reverting saving common paths exporting rendered HTML output from renderer process saving current files sending contents to renderer contents watching for changes in fileTypeIsSupported( ) function firesale-darwin-x64 directory frameworks adding new items building UIs in React Application component displaying lists of items electron-compile, overview of foundation for applications hot module reloading live reload fs.readFileSync( ) function functionality adding application-specific menu functionality implementing base functionality in application menus vs context menus in menus vs browsers requiring from another process

G

getAll( ) method getButtonParent( ) function getDraggedFile( ) function getDroppedFile( ) function getFileFromUser( ) function, 2^nd, 3^rd, 4^th getIcon( ) function getLinks function getMainProcessLogs( ) method getPath( ) method getRenderProcessLogs( ) method getSelectedText( ) method getText( ) method getWindow( ) method getWindowCount( ) method global shortcuts registering, 2^nd checking registrations solving for edge case when window has never been shown unregistering globalShortcut module, 2^nd globalShortcut.isRegistered( ) function globalShortcut.unregister( ) function globalShortcut.unregisterAll( ) method

H

handleChange( ) method handleError( ) function handleSubmit( ) method hasClass( ) method Help menus hot module reloading href attribute #html element

I

icons for applications, updating in Electron Packager for macOS for menu bars for Windows OS IDE (integrated development environment) import( ) function importing to Electron Forge IndexedDB connecting databases to UIs creating stores with getting data from writing data to innerHTML innerText insert( ) method installing Electron integrated development environment (IDE) interprocess communication, 2^nd CommonJS require systems overview of remote modules requiring functionality from another process sending content from main processes to renderer processes IPC (interprocess communication) ipcRenderer module, 2^nd isDarkMode( ) method isDevToolsOpened( ) method items adding overview of to databases deleting displaying lists of fetching from databases updating in databases ITunes Connect

J

JSX (JavaScript with XML)

K

keyboard shortcuts Keychain Access Knex.js query builder

L

<label> tag LevelUI library lighten( ) function lists of items, displaying live reload localStorage LSHandlerRank attribute

M

Mac App Store distributing applications through finishing touches uploading applications validating applications submitting applications to adding applications to iTunes Connect configuring application categories packaging applications for Mac App Store registering applications to open file type registering applications with Mac App Store signing applications macOS (operating system) implementing dialog sheets in integrating multiple windows with restoring application menus on signing applications for supporting dark mode in switching menu bar icons when pressed in updating represented file on using correct icons for main processes debugging overview of with Visual Studio Code multiple windows and, communication between overview of, 2^nd passing reference to current window to sending content to renderer processes from mainWindow, 2^nd mainWindow.webContents.loadURL( ) method mainWindow.webContents.openDevTools( ) method mainWindow.webContents.send( ) method map( ) method maps markAllAsPacked( ) method markAllAsUnpacked( ) method markAsPacked( ) method, 2^nd memory leaks menu bar icons menubar library, building applications with adding clippings to UIs adding secondary menus clippings in applications displaying notifications publishing clippings registering global shortcuts starting applications with menubars Menubar( ) function Menu.buildFromTemplate( ) function, 2^nd, 3^rd menus adding application-specific menu functionality disabling menu items in application menus in context menus enabling menu items in application menus in context menus functionality in context menus vs application menus vs browsers secondary menus shell module in application menus minidump_stackwalk command-line tool moveToObject( ) method multiple windows communicating between main processes and creating improving user experience of creating new windows integrating with macOS managing communicating between main processes and multiple windows passing reference to current window to main processes multiselections flag

N

native file dialog boxes, 2^nd CommonJS require systems overview of reading files using Node implementing dialog sheets in macOS scoping Open File dialogs triggering native module Node.js runtime accessing from browser context native modules IndexedDB storing data in SQLite databases overview of reading files implementing dialog sheets in macOS scoping Open File dialogs node_modules directory, 2^nd notes applications bootstrapping displaying browser windows implementing UIs debugging main processes renderer processes defining file structure of implementing base functionality notifications, displaying overview of solving for edge case when window has never been shown npm init command, 2^nd npm start command NW.js framework

O

onChange( ) function onCheckoff( ) function onClick function onDelete property onSubmit prop Open File dialogs open file type Open in Default Application button openDevTools( ) method openDirectory flag open-file event openFile( ) function, 2^nd, 3^rd, 4^th original-fs module output directory

P

package.json packaging applications for Mac App Store parsing responses path.basename( ) method persisting user data IndexedDB storing data in SQLite databases popup( ) method, 2^nd privileges process module process.crash( ) method processes, requiring functionality from another productName set properties property publishClipping( ) function publishing clippings put( ) method

Q

querySelector( ) method Quit command

R

React library building UIs in Application component displaying lists of items hooking databases into react preset reading from clipboard handling edge cases overview of readText( ) method ready event, 2^nd register( ) method registering applications to open file type with Mac App Store global shortcuts checking registrations overview of solving for edge case when window has never been shown remote modules remote.getCurrentWindow( ) function remote.require function remove( ) method removeClipping( ) function render( ) method renderApplication( ) function renderer contents renderer processes adding styles in creating debugging loading code from requiring files in saving files from sending content from main processes to shell module from UI in renderFile( ) function renderLinks( ) function replacing default menu request.post( ) method requests cross-origin requests displaying results require systems in CommonJS require( ) function responses parsing storing with web storage APIs response.text( ) method restrictions Revert buttons reverting files

S

sandboxing sanitize property Save buttons save flag saveHtml( ) function saving files common paths exporting rendered HTML output from renderer process scoping Open File dialogs <script> tags secondary menus select( ) method Selenium WebDriver servers, setting up for automatic updates to receive crash reports setDocumentEdited( ) method setPressedImage( ) method setRepresentedFilename( ) method setTitle( ) function shell module, 2^nd shell modules accessing from context menus functionality in application menus vs context menus functionality in menus vs browsers features of from UI in renderer processes in application menus Show File button showOpenDialog( ) method showOpenFile( ) function showSaveFileDialog( ) function signing applications for macOS for Windows overview of Spectron framework controlling APIs with overview of setting up testing applications with setting up test runners WebdriverIO writing asynchronous tests testing DOM with testing Electron BrowserWindow APIs traversing DOM with waiting for windows to load SQLite databases setting up storing data in adding items to databases deleting items fetching all items from databases hooking databases into React setting up SQLite and Knex.js storing databases updating items in databases using right versions with electron-rebuild sqlite3 modules squirrel events Squirrel.Windows framework src attribute startWatchingFile( ) function, 2^nd stopWatchingFile( ) function storeLink function stores with IndexedDB storing data in SQLite databases adding items to databases deleting items fetching all items from databases hooking databases into React setting up SQLite and Knex.js storing databases updating items in databases using right versions with electron-rebuild databases responses with web storage APIs styles in renderer processes systemPreferences module

T

target property test runners testing applications with Spectron overview of setting up setting up test runners WebdriverIO writing asynchronous tests DOM with Spectron Electron BrowserWindow APIs then( ) method third-party dependencies this.addItem( ) method this.deleteItem( ) method this.deleteUnpackedItems( ) method this.fetchItems( ) method this.markAsPacked( ) method titles of windows, updating tracking recently opened files transpilation, 2^nd transpilers adding new items building UIs in React Application component displaying lists of items electron-compile foundation for applications hot module reloading live reload tray module Clipmaster completed code for creating applications with reading from clipboard and storing clippings supporting dark mode in macOS using correct icons for macOS and Windows displaying notifications reading from clipboard registering global shortcuts switching menu bar icons when pressed in macOS unregistering global shortcuts writing to clipboard handling edge cases tree command triggering native file dialog boxes troubleshooting

U

UIs (user interfaces) adding clippings to building in React Application component displaying lists of items connecting databases to cross-origin requests displaying request results enabling Revert buttons in enabling Save buttons in error handling implementing parsing responses shell module from storing responses with web storage APIs troubleshooting uncaught exceptions unregistering global shortcuts update( ) method updateMenu( ) function updates-available event updateUserInterface( ) method updateWindowTitle( ) method updating application icons in Electron Packager applications automatically setting up automatic updates in Electron setting up servers for automatic updates items in databases represented file on macOS windows titles based on current file uploading applications url property url variable useNullAsDefault option user data, persisting IndexedDB storing data in SQLite databases

V

validating applications visual feedback Visual Studio Code IDE

W

waitUntilTextExists( ) method waituUntilWindowLoaded( ) method web storage APIs webContents property, 2^nd, 3^rd, 4^th webContents.savePage( ) method webContents.send( ) method WebdriverIO, 2^nd WebRTC WebSockets where( ) method will-finish-launching event Window menus window-all-closed event windows creating new handling cases of having no focused windows updating titles based on current file waiting to load Windows OS (operating system) overview of signing applications for Worldwide Developer Relations Certification Authority writeToClipboard( ) function writing asynchronous tests using Spectron controlling Electron APIs testing DOM testing Electron BrowserWindow APIs traversing DOM waiting for windows to load to clipboard handling edge cases overview of

X

Xcode, 2^nd XMLHttpRequests

Y

yarn run package

Previous Chapter

Code from the end of chapter 6

List of Figures