libui-node

Node.js bindings for libui library.

libui is a lightweight, portable GUI library that uses the native GUI technologies of each platform it supports.

It is in early stage of development, but is evolving at great pace and is really awesome. It could become an awesome alternative to Electron to develop multiplatform GUI, expecially suited to develop small apps.

Screenshots

macOS

Linux

Windows

Supported platforms

• Windows: Windows Vista SP2 with Platform Update or newer
• Unix: GTK+ 3.10 or newer
• Mac OS X: OS X 10.8 or newer
• Node.js version 4 or greater.

Prerequisites

Prebuilt binaries

All prebuilds are build on CI and afterwards downloaded and published in the npm install phase. Prebuild t binaries are available for the following platforms:

• macOS 64bit
• Windows 64bit
• Linux 64bit

If you are using one of these platform, you don't need to recompile libui-node source code from scratch.

The only additional dependecy you nedd is GTK+ 3 to run on Linux.

Otherwise, libui-node sources will be compiled during part of the install phase. You need the following additionl dependency in order to compile:

Windows

• windows-build-tools or Visual Studio 2015 to compile the project.
• Visual C++ Redistributable Package per Visual Studio 2013

Linux

If they are not provided by default in your distribution:

• build-essential to compile the project.
• GTK+ 3

macOS

• Xcode 8 to compile the project.

Installation

npm install -S libui-node

libui prebuilt binaries are automatically downloaded after install.

If you get this error on Windows:

'__pfnDliNotifyHook2': redefinition; different type modifiers

you need to install latest npm version:

$ npm i -g npm

see this node-gyp issue for more details.

Documentation & examples

Documentation is in docs folder. You can also find working examples in example folder.

How to run the examples

First, you have to clone the GitHub repo and npm install it:

git clone https://github.com/parro-it/libui-node.git
npm install

Then, to run the control gallery example (requires Node.js >= 6), type:

node example/core-api.js

Contribution & design

1. Make sure to read and agree with our code of conduct
2. Follow guidelines provided in our contribution guide

Related projects

• libui - Simple and portable (but not inflexible) GUI library in C that uses the native GUI technologies of each platform it supports.
• nbind - Magical headers that make your C++ library accessible from JavaScript
• proton-native - A React environment for cross platform native desktop apps https://proton-native.js.org
• vuido - Native desktop applications using Vue.js. https://proton-native.js.org

Contributors

| | | ---|---|---|--- Andrea Parodi | Juha Järvi | Niklas Mischkulnig | Gustav Hansen

License

The MIT License (MIT)

Copyright (c) 2018 parro-it