[
{
"path": ".gitignore",
"content": "node_modules\n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2018 Seyyid Fatih KOÇ\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.MD",
"content": "[](https://www.npmjs.com/package/electron-tray-window)\n[](https://github.com/sfatihk/electron-tray-window)\n[](https://github.com/sfatihk/electron-tray-window)\n[](https://github.com/sfatihk/electron-tray-window)\n[](https://github.com/sfatihk/electron-tray-window)\n\n\n\n\n\n\n![](\"resources/icon.png\")
\n
\nQuickly create customizable menu/pop-up for your application in system tray.
\n\n---\n\nElectron Tray Window, basically places the window near the tray icon. While these happening, you can customize window / tray or tracking the events.\n\n## Preview [demo project](https://github.com/sfatihk/electron-tray-window/tree/master/examples)\n\n![](\"https://raw.githubusercontent.com/sfatihk/electron-tray-window/master/resources/showcase-short.gif\")
![](\"https://raw.githubusercontent.com/sfatihk/electron-tray-window/master/resources/showcase.gif\")
\n\n## Install\n\n```\nnpm install electron-tray-window\n```\n\nor\n\n```\nyarn add electron-tray-window\n```\n\n## Usage\n\n```js\nconst trayWindow = require(\"electron-tray-window\");\n```\n\nYou can use different ways. \"setOptions()\" function accepts object value.\n\nIf you have already created tray or window outside **TrayWindow**, you can pass as arguments to **.setOptions()** function,\n\n```js\n//...\n\ntray = new Tray(...);\nwindow = new BrowserWindow(...);\nwindow.loadUrl(...);\n\ntrayWindow.setOptions({tray: tray,window: window});\n\n//...\n```\n\nor if you pass just tray icon path or window url, it prepare automatically.\n\n```js\n//...\n\ntrayWindow.setOptions({\n trayIconPath: \"...\",\n windowUrl: \"...\"\n});\n\n//...\n```\n\nBy the way you can make different combines. But object must contains;\n\n- **tray** or **trayIconPath**\n- **window** or **windowUrl**\n\n```js\n\n//...\n\ntray = new Tray(...);\ntrayWindow.setOptions({\n tray: tray,\n windowUrl: \"...\"\n});\n\n//...\n\nwindow = new BrowserWindow(...);\n\ntrayWindow.setOptions({\n trayIconPath: \"...\",\n window: window\n});\n\n//...\n```\n\n## Other Functions\n\nYou can always change **TrayWindow** with setOptions() and you can use different functions after setOptions().\n\n## .setTray( tray )\n\n```js\n//...\n\ntrayWindow.setOptions({...});\n\n//...\n\ndifferentTray = new Tray(...);\n\ntrayWindow.setTray(differentTray); //now, follows different tray\n\n//..\n```\n\n## .setWindow( window )\n\n```js\n//...\n\ntrayWindow.setOptions({...});\n\n//...\n\ndifferentWindow = new BrowserWindow(...);\n\ntrayWindow.setWindow(differentWindow); //now, shows different window\n\n//..\n```\n\n## .setWindowSize( object )\n\n```js\n//...\n\ntrayWindow.setOptions({...});\n\n//...\n\ndifferentWindow = new BrowserWindow(...);\n\ntrayWindow.setWindowSize({\n width : 200, //optional\n height : 300, //optional\n margin_x : 10, //optional\n margin_y : 10 //optional\n});\n\n//..\n```\n\n## Events\n\nYou can listen events. All event contains window and tray objects\n\n```js\n//...\nconst { ipcMain } = electron;\n\nipcMain.on(\"tray-window-ready\", (e, a) => {\n console.log(\"tray window is ready\");\n //console.log(e.window)\n //console.log(e.tray)\n});\n\nipcMain.on(\"tray-window-clicked\", (e, a) => {\n console.log(\"clicked the tray icon\");\n //console.log(e.window)\n //console.log(e.tray)\n});\n\nipcMain.on(\"tray-window-visible\", (e, a) => {\n console.log(\"tray window is visible now\");\n //console.log(e.window)\n //console.log(e.tray)\n});\n\nipcMain.on(\"tray-window-hidden\", (e, a) => {\n console.log(\"tray window is hidden now\");\n //console.log(e.window)\n //console.log(e.tray)\n});\n\n//..\n```\n\n## Overview\n\n### All parameters of setOptions()\n\n| parameter | description | default |\n| ------------ | ------------------------------------------------ | ------- |\n| tray | Electron's tray object type | |\n| trayIconPath | Image file path | |\n| window | Electron's BrowserWindow object type | |\n| windowUrl | Html etc. file path or website url | |\n| width | Window width | 200px |\n| height | Window height | 200px |\n| margin_x | Vertical distance between window and tray icon | 0px |\n| margin_y | Horizontal distance between window and tray icon | 0px |\n| framed | Is it window framed? | false |\n\n### Other functions\n\n| function | description |\n| ------------- | ----------------------------------------------------------------- |\n| setTray | Electron's tray object type. |\n| setWindow | Electron's BrowserWindow object type |\n| setWindowSize | Object type. Optional arguments width, height, margin_x, margin_y |\n\n### IPC (Inter-Process Communication) Events\n\n| event | description |\n| ------------------- | ------------------------ |\n| tray-window-ready | when created TrayWindow. |\n| tray-window-clicked | when clicked tray icon |\n| tray-window-visible | when window show up |\n| tray-window-hidden | when window close down |\n\n### Default Window Properties\n\n| properties | default in TrayWindow |\n| ------------------------------------ | --------------------- |\n| width | 200px |\n| height | 300px |\n| maxWidth | 200px |\n| maxHeight | 300px |\n| show | false |\n| frame | false |\n| fullscreenable | false |\n| resizable | false |\n| useContentSize | true |\n| transparent | true |\n| alwaysOnTop | true |\n| webPreferences{backgroundThrottling} | false |\n\nP.S. : if you use this way `setOptions({windowUrl:\"...\"})`, default window values uses.\n"
},
{
"path": "examples/README.MD",
"content": "## install dependencies\n```npm install```\n\n## then run the project\n```npm start```\n"
},
{
"path": "examples/index.js",
"content": "const TrayWindow = require(\"electron-tray-window\");\n\nconst { ipcMain, Tray, app, BrowserWindow } = require(\"electron\");\nconst path = require(\"path\");\n\napp.on(\"ready\", () => {\n var timeout = 10;\n if (process.platform === \"linux\") {\n timeout = 200;\n }\n setTimeout(function () {\n TrayWindow.setOptions({\n trayIconPath: path.join(\"resources/icon.png\"),\n windowUrl: `file://${path.join(__dirname, \"resources/index.html\")}`,\n width: 340,\n height: 380,\n });\n }, timeout);\n});\n"
},
{
"path": "examples/package.json",
"content": "{\n \"name\": \"examples\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\",\n \"start\": \"electron --enable-transparent-visuals .\"\n },\n \"author\": \"sfatihk \",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"electron-tray-window\": \"^1.2.2\"\n }\n}\n"
},
{
"path": "examples/resources/index.html",
"content": "\n\n \n \n Electron-Tray-Window Example\n \n \n\n \n \n
\n
ELECTRON
\n
TRAY
\n
\n
WINDOWS
\n