{"id":14978527,"url":"https://github.com/el3um4s/ipc-for-electron-window-controls","last_synced_at":"2026-02-22T02:02:46.413Z","repository":{"id":56855706,"uuid":"525553540","full_name":"el3um4s/ipc-for-electron-window-controls","owner":"el3um4s","description":"Allow the renderer to close, minimize and maximize the window (for desktop Electron)","archived":false,"fork":false,"pushed_at":"2023-02-04T15:43:33.000Z","size":994,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-08T15:46:24.035Z","etag":null,"topics":["electron","electronjs","inter-process-communication","ipc","maximize","minimize","node","nodejs","npm","restore","ts","typescript","window","window-controls"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/el3um4s.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["el3um4s"],"patreon":"el3um4s","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/el3um4s"]}},"created_at":"2022-08-16T21:55:16.000Z","updated_at":"2022-08-17T14:18:44.000Z","dependencies_parsed_at":"2023-02-18T17:31:21.424Z","dependency_job_id":null,"html_url":"https://github.com/el3um4s/ipc-for-electron-window-controls","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":"el3um4s/typescript-npm-package-starter","purl":"pkg:github/el3um4s/ipc-for-electron-window-controls","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron-window-controls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron-window-controls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron-window-controls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron-window-controls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/el3um4s","download_url":"https://codeload.github.com/el3um4s/ipc-for-electron-window-controls/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/el3um4s%2Fipc-for-electron-window-controls/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29703254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T23:35:04.139Z","status":"online","status_checked_at":"2026-02-22T02:00:08.193Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","electronjs","inter-process-communication","ipc","maximize","minimize","node","nodejs","npm","restore","ts","typescript","window","window-controls"],"created_at":"2024-09-24T13:57:51.157Z","updated_at":"2026-02-22T02:02:46.384Z","avatar_url":"https://github.com/el3um4s.png","language":"TypeScript","funding_links":["https://github.com/sponsors/el3um4s","https://patreon.com/el3um4s","https://www.paypal.me/el3um4s"],"categories":[],"sub_categories":[],"readme":"# IPC for Electron: Window Controls\n\nAllow the renderer to close, minimize and maximize the window (for desktop Electron)\n\nNPM link: [@el3um4s/ipc-for-electron-window-controls](https://www.npmjs.com/package/@el3um4s/ipc-for-electron-window-controls)\n\nUse [@el3um4s/ipc-for-electron](https://www.npmjs.com/package/@el3um4s/ipc-for-electron) and [@el3um4s/renderer-for-electron-window-controls](https://www.npmjs.com/package/@el3um4s/renderer-for-electron-window-controls) to allow communication between Electron and a web page\n\n### Install and use the package\n\nTo use the package in a project:\n\n```bash\nnpm i @el3um4s/ipc-for-electron @el3um4s/ipc-for-electron-window-controls @el3um4s/renderer-for-electron-window-controls\n```\n\nThen the `preload.ts` file:\n\n```ts\nimport { generateContextBridge } from \"@el3um4s/ipc-for-electron\";\nimport windowControls from \"@el3um4s/ipc-for-electron-window-controls\";\n\nconst listAPI = [windowControls];\n\ngenerateContextBridge(windowControls);\n```\n\nIn the renderer file:\n\n```ts\nimport windowControls from \"@el3um4s/renderer-for-electron-window-controls\";\n\nwindowControls.minimize();\nwindowControls.maximize();\nwindowControls.unmaximize();\nwindowControls.close();\n```\n\nIn the renderer you can use:\n\n```ts\nglobalThis.ipc.windowControls.send(\"minimize\", null);\nglobalThis.ipc.windowControls.send(\"maximize\", null);\nglobalThis.ipc.windowControls.send(\"unmaximize\", null);\nglobalThis.ipc.windowControls.send(\"close\", null);\n```\n\n### API: Electron Side\n\n- `minimize` - Minimize the window\n- `maximize` - Maximize the window\n- `unmaximize` - Unmaximize the window\n- `close` - Close the window\n\n### API: Renderer Side - Request\n\n`minimize = (options: { apiKey?: string }): void`\n\nexample:\n\n```ts\nimport windowControls from \"@el3um4s/renderer-for-electron-window-controls\";\n\nwindowControls.minimize();\n```\n\n`maximize = (options: { apiKey?: string }): void`\n\nexample:\n\n```ts\nimport windowControls from \"@el3um4s/renderer-for-electron-window-controls\";\n\nwindowControls.maximize({ apiKey: \"my-api-key\" });\n```\n\n`unmaximize = (options: { apiKey?: string }): void`\n\nexample:\n\n```ts\nimport windowControls from \"@el3um4s/renderer-for-electron-window-controls\";\n\nwindowControls.unmaximize();\n```\n\n`close = (options: { apiKey?: string }): void`\n\nexample:\n\n```ts\nimport windowControls from \"@el3um4s/renderer-for-electron-window-controls\";\n\nwindowControls.close();\n```\n\n### Types\n\n**DefaultApiKey**\n\n```ts\ntype DefaultApiKey = \"ipc\";\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel3um4s%2Fipc-for-electron-window-controls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fel3um4s%2Fipc-for-electron-window-controls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fel3um4s%2Fipc-for-electron-window-controls/lists"}