repository·main·Indexed 12 days ago
https://github.com/nwjs/nw.jsAn application runtime that enables developers to build native desktop applications using web technologies (HTML, CSS, and JavaScript) by combining the Chromium engine with Node.js.
The close event is emitted when Window.close() is called. If you listen to this event, Window.close() will not actually close the window immediately. This allows you to perform shutdown tasks.
Important: To force the window to close after your tasks are done, you must call this.close(true). Calling this.close() without true inside the close event listener will cause an infinite loop.
Best Practice: To provide a smooth user experience, call this.hide() immediately in the close event so the window disappears instantly, then perform your cleanup and call this.close(true).
Mac Note: On Mac, the callback receives an argument indicating if the window is being closed via <kbd>⌘</kbd>+<kbd>Q</kbd>. It is set to the string 'quit' if true, otherwise undefined.
// Listen to main window's close event
nw.Window.get().on('close', function () {
// Hide the window to give user the feeling of closing immediately
this.hide();
// Perform shutdown work...
// Finally, force close
this.close(true);
});NW.js allows you to call Node.js code and modules directly from your web pages. You can use require() to load built-in Node.js modules (like os, fs, etc.) or modules installed via npm.
<script>
// Use the Node.js 'os' module directly in the browser context
var os = require('os');
document.write('You are running on ', os.platform());
</script>Content verification (also known as "app signing") is a security feature that prevents the loading of unsigned files when using an official NW.js binary.
When an application is signed, a verified_contents.json file is generated containing signatures for the application files using a private key. The corresponding public key is embedded within the NW.js binary.
To run a signed application with strict enforcement, use the --verify-content=enforce_strict flag. If any file (such as index.html) is modified after signing, NW.js will detect the corruption and terminate immediately.
Security Note: This feature prevents loading unsigned files with your official binary, but it does not prevent an attacker from loading your modified app using a different, non-official NW.js binary. For higher security, consider using C++ modules, NaCl, or compiling JavaScript to binary with nwjc.
nw --verify-content=enforce_strict .In NW.js, scripts running in different windows or frames live in different JavaScript contexts. Each context has its own global object and its own set of global constructors (like Array or Object). This isolation prevents prototype pollution from one window affecting another and provides security boundaries between windows.
NW.js operates using two primary types of contexts:
<script> tags, jQuery, RequireJS). It has access to DOM APIs and Web APIs.require() or the node-main manifest field. It has access to Node.js globals like __dirname and process, but cannot access Web APIs (like document or alert()) directly.By default, NW.js runs in Separate Context Mode, where these two types of contexts are distinct.
Pre-built NW.js binaries do not include certain proprietary codecs (like H.264) due to licensing and patent constraints. To use these codecs, you must either use community-provided binaries or build your own FFmpeg DLL/NW.js build.
Warning on Licensing: Using H.264 requires compliance with patent royalties and source code licenses. Consult a lawyer regarding licensing constraints. Simply using these workarounds does not grant you the legal right to redistribute patented media formats.
The behavior of relative paths in Node's require() method changes depending on the JavaScript context of the file calling it:
The Native Client programming model supports bidirectional, asynchronous communication between JavaScript and the Native Client module.
.postMessage() method on the module instance (retrieved via an <embed> tag) to send data to the C++ module.HandleMessage() member function to receive messages and use PostMessage() to send responses back to JavaScript.NW.js is an application runtime that combines Chromium and Node.js.
Key architectural features include:
npm directly from your web pages.NW.js supports NaCl (Native Client) and PNaCl (Portable Native Client), allowing you to embed native C++ modules within your application.
Requirement: This feature is only available in the SDK and NaCl flavor of NW.js. If you are using a standard build, you will not be able to use these features.
The tray.menu property defines the menu that appears when interacting with the tray. Because interaction patterns vary by OS, setting the menu property is the standard way to ensure cross-platform compatibility:
click event instead of showing the menu.NW.js now runs internally as a Chrome App. Key architectural shifts include:
file:// to chrome-extension://. The app:// protocol from older versions is replaced by chrome-extension:// (where the host is the generated ID).require()) have moved from nw.gui to the nw object. While a compatibility wrapper for nw.gui is provided, it is slated for deprecation.chrome.* platform APIs directly within the Node context.--mixed-context flag, nw.* acts as a mirror of window.*. Warning: In this mode, you cannot share variables among frames or windows by assigning them to the Node context. Avoid this mode if your app relies on variable sharing via the Node context.main field in package.json, NW.js internally launches the first window via JS from the background page.