Native UI API Manual

NOTE: some content in this wiki applies only to 0.12 and earlier versions. For official documentation on 0.13 and later, see http://docs.nwjs.io

Native UI API requires node-webkit >= 0.3.0

Overview

• API Overview and Notices - Read it before using APIs
• API Implementation Document - How our APIs are implemented in C++

Categories

Extended Window APIs

• Window
• Frameless Window

Menus

• Menu
• MenuItem
• Window menu - notes on window's menubar

Platform Services

• App - per-app global functions
• Clipboard - or Pasteboard
• Tray - or Status Icon, Status Item, Notification Area Icon
• File dialogs
• Shell - platform-dependent desktop functions
• Handling files and arguments
• Screen - Screen geometry functions

Tips

• Show window after page is ready
• Minimize to tray
• Preserve window state between sessions