Merge pull request #144 from tkambler/developmentIntoMaster

Merge development into master
snapcrunch · Mar 29, 2022 · 83e6bb9 · 83e6bb9
2 parents e6c856c + bbaa999
commit 83e6bb9
Show file tree

Hide file tree

Showing 10 changed files with 7,733 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,8 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Set defaults for new preferences added in a group after app has started (#141)
+- Include files to be exposed in npm build (#119)
+- Correct `menuBar` option in README (#130)
+- Updated dependencies
+- Improve README.md
+
 ### Added
-- Button component. Will trigger an event on the preferences.click when clicked.
+- Button component. Will trigger an event on the `preferences.click` when clicked. (#99)
+- Expose `close` function on preference object to close the preference window if opened (#130)
+- Expose `closePreferences` function on the ipcRenderer to close the preference window if opened (#130)
 
 ## [2.5.0] - 2021-09-18
 ### Fixed

diff --git a/example/index.html b/example/index.html
@@ -6,7 +6,10 @@
         <link rel="stylesheet" href="style.css">
     </head>
     <body>
-        <button class="bt">Click here to launch the preferences window</button>
+        <div class="buttons">
+            <button class="bt">Click here to launch the preferences window</button>
+            <button class="bt">Close preference window if opened</button>
+        </div>
         <pre class="preferences"></pre>
         <script src="renderer.js"></script>
     </body>

diff --git a/example/preferences.js b/example/preferences.js
@@ -1,7 +1,7 @@
 'use strict';
 
-// Const electron = require('electron');
-// const app = electron.app;
+const electron = require('electron');
+const { Menu } = electron;
 const path = require('path');
 const os = require('os');
 const ElectronPreferences = require('../');
@@ -23,6 +23,21 @@ const preferences = new ElectronPreferences({
 	webPreferences: {
 		webSecurity: true,
 	},
+	menuBar: Menu.buildFromTemplate(
+		[
+			{
+				label: 'Window',
+				role: 'window',
+				submenu: [
+					{
+						label: 'Close',
+						accelerator: 'CmdOrCtrl+W',
+						role: 'close',
+					},
+				],
+			},
+		],
+	),
 	browserWindowOverrides: {
 		title: 'My Electron Preferences',
 	},

diff --git a/example/preload.js b/example/preload.js
@@ -12,6 +12,11 @@ contextBridge.exposeInMainWorld('api', {
 
 		ipcRenderer.send('showPreferences');
 
+	},
+	closePreferences: () => {
+
+		ipcRenderer.send('closePreferences');
+
 	},
 	getPreferences: () => ipcRenderer.sendSync('getPreferences'),
 	onPreferencesChanged(handler) {

diff --git a/example/renderer.js b/example/renderer.js
@@ -2,6 +2,7 @@
 'use strict';
 
 const bt = document.querySelectorAll('.bt')[0];
+const bt2 = document.querySelectorAll('.bt')[1];
 const prefsElement = document.querySelectorAll('.preferences')[0];
 prefsElement.innerHTML = JSON.stringify(api.getPreferences(), null, 4);
 
@@ -11,6 +12,12 @@ bt.addEventListener('click', () => {
 
 });
 
+bt2.addEventListener('click', () => {
+
+	api.closePreferences();
+
+});
+
 api.onPreferencesChanged(preferences => {
 
 	console.log('Preferences were updated', preferences);

diff --git a/example/style.css b/example/style.css
@@ -2,6 +2,12 @@ body {
     background: white;
 }
 
+.buttons {
+    display: flex;
+    flex-direction: row;
+    justify-content: space-between;
+}
+
 .bt {
     margin: 25px;
 }

diff --git a/index.js b/index.js
@@ -106,6 +106,12 @@ class ElectronPreferences extends EventEmitter2 {
 
 		});
 
+		ipcMain.on('closePreferences', _ => {
+
+			this.close();
+
+		});
+
 		ipcMain.on('getSections', event => {
 
 			event.returnValue = this.options.sections;
@@ -269,6 +275,7 @@ class ElectronPreferences extends EventEmitter2 {
 
 		const unOverridableWebPreferences = {
 			contextIsolation: true,
+			devTools: this.options.debug ? true : undefined,
 		};
 
 		// User provided `browserWindow`, we load those
@@ -375,6 +382,18 @@ class ElectronPreferences extends EventEmitter2 {
 
 	}
 
+	close() {
+
+		if (!this.prefsWindow) {
+
+			return;
+
+		}
+
+		this.prefsWindow.close();
+
+	}
+
 }
 
 module.exports = ElectronPreferences;