hatrang174 / webview-nodejs

A Node.js binding to webview

webview-nodejs

English | 中文(简体)

A Node.js binding and wrapper for webview, a tiny cross-platform webview library to build modern cross-platform desktop GUIs using WebKit (Gtk/Cocoa) and Edge (Windows).

Getting Started

1. Install via npm

npm i webview-nodejs

2. Import and use webview

const { Webview } = require('webview-nodejs');

let w = new Webview();
w.title("Hello World");
w.size(800,600);
w.navigate("https://example.com");
w.show();

For more examples like interacting between Node.js and webview and more detailed instructions see Tutorial.

Help

• Tutorial
• Documentation
• Examples
• webview.dev
• Limitations and Workarounds

Supported Platforms

Build-in support:

• win32 x64
• linux x64
• osx x64
• osx aarch64

By loading lib manully, other architectures could be supported, you could find them here. Only windows-x64 and linux-x64 are tested.

For more information, see Prerequisites.

Contribution

All suggestions, pull requests, issues, discussions and other contributions are welcome and appreciated.

Credits

Project	License
webview	MIT
webview_deno	MIT
node-ffi-napi	MIT
Microsoft Webview2	BSD-style

License

Copyright 2022 Winterreisender and other contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX short identifier: Apache-2.0