custom-electron-titlebar 4.2.0-alpha.2 → 4.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 - now Alex Torres
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2018 Alex Torres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,65 +1,83 @@
-# Custom Electron Titlebar
-
-This project is a typescript library for electron that allows you to configure a fully customizable title bar.
-
-[![LICENSE](https://img.shields.io/github/license/AlexTorresSk/custom-electron-titlebar.svg)](https://github.com/AlexTorresSk/custom-electron-titlebar/blob/master/LICENSE)
-[![NPM Version](https://img.shields.io/npm/v/custom-electron-titlebar.svg)](https://npmjs.org/package/custom-electron-titlebar)
-[![install size](https://packagephobia.com/badge?p=custom-electron-titlebar)](https://packagephobia.com/result?p=custom-electron-titlebar)
-
-![Screenshot 1](screenshots/cet-001.jpg)
-
-![Screenshot 2](screenshots/cet-002.jpg)
-
-![Screenshot 3](screenshots/cet-003.jpg)
-<br><br>
-
-# 📦 Installing
-You can install this package with `npm`.
-```sh
-npm install custom-electron-titlebar
-```
-<br>
-
-# 🛠️ Usage
-The implementation is done as follows:
-
-In the main application file (main.js or .ts)
-```js
-import { setupTitlebar, attachTitlebarToWindow } from "custom-electron-titlebar/main";
-
-// setup the titlebar main process
-setupTitlebar();
-
-function createWindow() {
-  // Create the browser window.
-  const mainWindow = new BrowserWindow({
-    width: 800,
-    height: 600,
-    titleBarStyle: 'hidden',
-    //frame: false, // needed if process.versions.electron < 14
-    webPreferences: {
-      preload: path.join(__dirname, 'preload.js')
-    }
-  });
-  
-  ...
-
-  // attach fullscreen(f11 and not 'maximized') && focus listeners
-  attachTitlebarToWindow(mainWindow);
-}
-```
-
-In the preload file (preload.js or .ts)
-```js
-import { Titlebar } from "custom-electron-titlebar";
-
-window.addEventListener('DOMContentLoaded', () => {
-  // Title bar implemenation
-  new Titlebar();
-});
-```
-To see the options you can include in the Title Bar constructor, such as color of elements, icons, menu position, and much more, and the methods you can use, go to the [wiki](https://github.com/AlexTorresSk/custom-electron-titlebar/wiki)
-<br><br>
-
-## ✅ License
-This project is under the [MIT](https://github.com/AlexTorresSk/custom-electron-titlebar/blob/master/LICENSE) license.
+# Custom Electron Titlebar
+
+This project is a typescript library for electron that allows you to configure a fully customizable title bar.
+
+[![LICENSE](https://img.shields.io/github/license/AlexTorresDev/custom-electron-titlebar.svg)](https://github.com/AlexTorresDev/custom-electron-titlebar/blob/master/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/custom-electron-titlebar.svg)](https://npmjs.org/package/custom-electron-titlebar)
+[![install size](https://packagephobia.com/badge?p=custom-electron-titlebar)](https://packagephobia.com/result?p=custom-electron-titlebar)
+
+[📄 Visit Documentation](https://cet.alextrs.dev)
+
+Standard Title Bar
+
+![Screenshot 1](screenshots/cet-1.png)
+
+Bottom Menu Bar
+
+![Screenshot 2](screenshots/cet-2.png)
+
+Menu
+
+![Screenshot 3](screenshots/cet-3.png)
+
+Custom color
+
+![Screenshot 4](screenshots/cet-4.png)
+
+# 📦 Installing
+You can install this package with `npm`.
+```sh
+npm install custom-electron-titlebar
+```
+
+# 🛠️ Usage
+The implementation is done as follows:
+
+In the main application file (main.js or .ts)
+```js
+import { setupTitlebar, attachTitlebarToWindow } from "custom-electron-titlebar/main";
+
+// setup the titlebar main process
+setupTitlebar();
+
+function createWindow() {
+  // Create the browser window.
+  const mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    titleBarStyle: 'hidden',
+    //frame: false, // needed if process.versions.electron < 14
+    webPreferences: {
+      sandbox: false,
+      preload: path.join(__dirname, 'preload.js')
+    }
+  });
+  
+  ...
+
+  // attach fullScreen(f11 and not 'maximized') && focus listeners
+  attachTitlebarToWindow(mainWindow);
+}
+```
+
+In the preload file (preload.js or .ts)
+```js
+import { Titlebar } from "custom-electron-titlebar";
+
+window.addEventListener('DOMContentLoaded', () => {
+  // Title bar implementation
+  new Titlebar();
+});
+```
+To see the options you can include in the Title Bar constructor, such as color of elements, icons, menu position, and much more, and the methods you can use, go to the [wiki](https://github.com/AlexTorresDev/custom-electron-titlebar/wiki)
+
+## 💰 Support
+If you want to support my development, you can do so by donating through [Buy me a coffee](https://www.buymeacoffee.com/AlexTorresDev)
+
+
+## 📝 Collaborators
+I would like to express my sincere gratitude to all the people who have collaborated in the development and advancement of this project. I appreciate your contributions.
+
+
+## ✅ License
+This project is under the [MIT](https://github.com/AlexTorresDev/custom-electron-titlebar/blob/master/LICENSE) license.

package/package.json

@@ -1,58 +1,69 @@
-{
-  "name": "custom-electron-titlebar",
-  "version": "4.2.0-alpha.2",
-  "description": "Library for electron that allows you to configure a fully customizable title bar.",
-  "main": "dist/index.js",
-  "exports": {
-    ".": "./dist/index.js",
-    "./main": "./main/main.js"
-  },
-  "scripts": {
-    "build:develop": "webpack --mode=development",
-    "build": "webpack --mode=production",
-    "example": "electron example/main.js",
-    "start": "npm run build:develop && npm run example",
-    "prepare": "npm run build"
-  },
-  "author": "AlexTorresSk <alextorressk@gmail.com>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/AlexTorresSk/custom-electron-titlebar.git"
-  },
-  "keywords": [
-    "typescript",
-    "electron",
-    "title bar",
-    "menubar",
-    "windows",
-    "linux"
-  ],
-  "bugs": {
-    "url": "https://github.com/AlexTorresSk/custom-electron-titlebar/issues"
-  },
-  "homepage": "https://github.com/AlexTorresSk/custom-electron-titlebar#readme",
-  "directories": {
-    "example": "example",
-    "dist": "dist"
-  },
-  "peerDependencies": {
-    "electron": ">=10"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.19.3",
-    "@babel/preset-env": "^7.19.3",
-    "@types/node": "^18.8.0",
-    "babel-loader": "^8.2.5",
-    "css-loader": "^6.7.1",
-    "electron": "^21.0.1",
-    "sass": "^1.55.0",
-    "sass-loader": "^13.0.2",
-    "style-loader": "^3.3.1",
-    "ts-loader": "^9.4.1",
-    "tsconfig-paths-webpack-plugin": "^4.0.0",
-    "typescript": "^4.8.4",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0"
-  }
-}
+{
+  "name": "custom-electron-titlebar",
+  "version": "4.2.0",
+  "description": "Library for electron that allows you to configure a fully customizable title bar.",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "main": [
+        "./dist/main/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./main": "./dist/main/index.js"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "build:package": "tsc && tsc-alias",
+    "build:babel": "babel ./dist --out-dir ./dist --extensions \".js\"",
+    "start": "electron example/main.js",
+    "dev": "npm run build && npm run start",
+    "build": "npm run clean && npm run build:package && npm run build:babel"
+  },
+  "author": "AlexTorresDev <alextorressk@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AlexTorresDev/custom-electron-titlebar.git"
+  },
+  "keywords": [
+    "typescript",
+    "electron",
+    "title bar",
+    "menubar",
+    "windows",
+    "linux"
+  ],
+  "bugs": {
+    "url": "https://github.com/AlexTorresDev/custom-electron-titlebar/issues"
+  },
+  "homepage": "https://github.com/AlexTorresDev/custom-electron-titlebar#readme",
+  "directories": {
+    "example": "example",
+    "dist": "dist"
+  },
+  "peerDependencies": {
+    "electron": ">20.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.21.5",
+    "@babel/core": "7.21.8",
+    "@typescript-eslint/eslint-plugin": "5.59.2",
+    "@typescript-eslint/parser": "5.59.2",
+    "babel-plugin-import-require-as-string": "1.0.2",
+    "babel-plugin-module-resolver": "5.0.0",
+    "babel-plugin-rewire": "1.2.0",
+    "electron": "24.2.0",
+    "eslint": "8.40.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-config-standard": "17.0.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-n": "15.7.0",
+    "eslint-plugin-promise": "6.1.1",
+    "rimraf": "5.0.0",
+    "tsc-alias": "1.8.6",
+    "typescript": "5.0.4"
+  }
+}

package/dist/enums/menu-state.d.ts

@@ -1,6 +0,0 @@
-export declare enum MenubarState {
-    HIDDEN = 0,
-    VISIBLE = 1,
-    FOCUSED = 2,
-    OPEN = 3
-}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-import { Titlebar } from './titlebar';
-import { Color } from 'vs/base/common/color';
-export { Titlebar, Color };