{"id":27736850,"url":"https://github.com/winterreisender/webview-nodejs","last_synced_at":"2025-04-28T14:33:35.735Z","repository":{"id":58835897,"uuid":"533807120","full_name":"Winterreisender/webview-nodejs","owner":"Winterreisender","description":"A Node.js binding to webview","archived":false,"fork":false,"pushed_at":"2025-02-07T14:25:19.000Z","size":1864,"stargazers_count":97,"open_issues_count":3,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T08:20:47.289Z","etag":null,"topics":["cross-platform","desktop","javascript","nodejs","typescript","webui","webview"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Winterreisender.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-07T14:39:42.000Z","updated_at":"2025-03-31T21:30:04.000Z","dependencies_parsed_at":"2023-11-08T13:37:40.469Z","dependency_job_id":"229cd03d-e9da-45ad-9181-e2546f64141a","html_url":"https://github.com/Winterreisender/webview-nodejs","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Winterreisender%2Fwebview-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Winterreisender%2Fwebview-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Winterreisender%2Fwebview-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Winterreisender%2Fwebview-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Winterreisender","download_url":"https://codeload.github.com/Winterreisender/webview-nodejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251330760,"owners_count":21572349,"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":["cross-platform","desktop","javascript","nodejs","typescript","webui","webview"],"created_at":"2025-04-28T14:33:34.960Z","updated_at":"2025-04-28T14:33:35.693Z","avatar_url":"https://github.com/Winterreisender.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webview-nodejs\r\n\r\n[![npm version](https://img.shields.io/npm/v/webview-nodejs)](https://www.npmjs.com/package/webview-nodejs)\r\n[![npm version@next](https://img.shields.io/npm/v/webview-nodejs/next)](https://www.npmjs.com/package/webview-nodejs)\r\n![npm bundle size (version)](https://img.shields.io/bundlephobia/min/webview-nodejs/latest)\r\n![npm download](https://img.shields.io/npm/dt/webview-nodejs)\r\n![Work with Bun](https://img.shields.io/badge/work_with-Bun-yellow?logo=bun)\r\n![license](https://img.shields.io/github/license/Winterreisender/webviewko?color=3DA639)\r\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FWinterreisender%2Fwebview-nodejs.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FWinterreisender%2Fwebview-nodejs?ref=badge_shield)\r\n\r\nA Node.js binding and wrapper for [webview](https://github.com/webview/webview), a tiny cross-platform webview library to build modern cross-platform desktop GUIs using WebKit (Gtk/Cocoa) and Edge (Windows).\r\n\r\n![screenshot](docs/screenshot/screenshot.webp)\r\n\r\n## Getting Started\r\n\r\n1. Prerequisites  \r\n\r\n    - Common: Node.js 12 or later, CMake   \r\n    (you can install cmake by `winget install Kitware.CMake`, `apt install cmake` or `brew install cmake` ,please reopen your console after the installation)\r\n    - Windows: [Webview 2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/), Visual Studio Build Tools or Visual Studio with C++ support  \r\n    - Linux: [webkitgtk2](https://webkitgtk.org/), gcc  \r\n    - macOS: XCode  \r\n    - For more information, see [webview#prerequisites](https://github.com/webview/webview#prerequisites)\r\n\r\n\r\n2. Install webview-nodejs\r\n\r\n```shell\r\nnpm install webview-nodejs\r\n```\r\n\r\n3. Import and use webview\r\n\r\n```js\r\nconst { Webview } = require('webview-nodejs');\r\n\r\nlet w = new Webview();\r\nw.title(\"Hello World\");\r\nw.size(800,600);\r\nw.navigate(\"https://example.com\");\r\nw.show();\r\n```\r\n\r\nFor more examples like interacting between Node.js and webview and more detailed instructions, see [Tutorial](https://github.com/Winterreisender/webview-nodejs/wiki/Tutorial).\r\n\r\n## Help\r\n\r\n- [Tutorial](https://github.com/Winterreisender/webview-nodejs/wiki/Tutorial)\r\n- [API Reference](https://winterreisender.github.io/webview-nodejs/docs/jsdoc/index.html)\r\n- [Examples](https://github.com/Winterreisender/webview-nodejs/tree/master/test/)\r\n- [Demo Application](https://github.com/Winterreisender/webview-nodejs-demo-app)\r\n- The document of [webview](https://webview.dev/)\r\n- [Limitations and Workarounds](https://github.com/Winterreisender/webview-nodejs/wiki/Limitations-and-Workarounds)\r\n\r\n\r\n## Contribution\r\n\r\nAll suggestions, pull requests, issues, discussions and other contributions are welcome and appreciated.  \r\n\r\n## License\r\n\r\n```text\r\nCopyright 2022-2023 Winterreisender and other contributors.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\nhttp://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinterreisender%2Fwebview-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwinterreisender%2Fwebview-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinterreisender%2Fwebview-nodejs/lists"}