{"id":13767420,"url":"https://github.com/nodegui/os-utils","last_synced_at":"2025-04-27T17:32:25.353Z","repository":{"id":35717384,"uuid":"217627399","full_name":"nodegui/os-utils","owner":"nodegui","description":"A helper module for NodeGui which contains OS specific native features.","archived":false,"fork":false,"pushed_at":"2022-12-10T06:50:00.000Z","size":256,"stargazers_count":10,"open_issues_count":20,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T23:02:51.771Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodegui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-25T23:11:40.000Z","updated_at":"2024-04-14T16:38:14.000Z","dependencies_parsed_at":"2022-08-08T10:30:48.172Z","dependency_job_id":null,"html_url":"https://github.com/nodegui/os-utils","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fos-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fos-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fos-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodegui%2Fos-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodegui","download_url":"https://codeload.github.com/nodegui/os-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251178044,"owners_count":21548154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-03T16:01:08.538Z","updated_at":"2025-04-27T17:32:24.876Z","avatar_url":"https://github.com/nodegui.png","language":"C++","readme":"# os-utils\n\n[![npm version](https://img.shields.io/npm/v/@nodegui/os-utils.svg)](https://www.npmjs.com/package/@nodegui/os-utils)\n\nA helper module which contains OS specific native features.\n\n## Installation\n\n```\nnpm install @nodegui/os-utils\n```\n\n## Usage\n\n```js\nimport { Dock } from \"@nodegui/os-utils\";\n\nconsole.log(\"Showing the Dock icon on macOS\");\nDock.show();\nconsole.log(\"Hiding the Dock icon on macOS\");\nDock.hide();\n```\n\n```js\nimport { AboutPanel } from \"@nodegui/os-utils\";\n\nconsole.log(\"Open the about panel on macOS\");\nAboutPanel.open();\nconsole.log(\"Open the about panel on macOS with modified defaults\");\nAboutPanel.open({ name: \"Custom name\", version: \"2.3.5\" });\n```\n\n```js\nimport { Info } from \"@nodegui/os-utils\";\n\nconsole.log(\"isDarkMode: \" + Info.isDarkMode());\n```\n\n## Supported APIs\n\n### macOS\n\n- Dock\n\n  - `show()` - static method - Shows the Dock icon on macOS. Does nothing on other platforms.\n  - `hide()` - static method - Hides the Dock icon on macOS. Does nothing on other platforms.\n\n- AboutPanel\n\n  - `open(options?: object)` - static method - Opens the about panel on macOS. Does nothing on other platforms. `options` is optional and can contain the following strings: `name`, `version`, `applicationVersion`, and `copyright`. The default values are derived from `Info.plist`.\n\n- Info\n  - `isDarkMode` - static method - Checks if the OS theme is dark mode in macOS. Does nothing on other platforms and returns false. Returns a boolean.\n\n## License\n\nMIT\n","funding_links":[],"categories":["Plugins"],"sub_categories":["Samples and Experiments"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodegui%2Fos-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodegui%2Fos-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodegui%2Fos-utils/lists"}