Skip to content
This repository has been archived by the owner on Oct 11, 2018. It is now read-only.

Latest commit

 

History

History
69 lines (45 loc) · 2.17 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.17 KB
Raw

QML Browserify

Browserify for QML

Install

npm install -g qml-browserify

Bundling

Bundle a js file: qml-browserify -i index.js -o bundle.js

Bundle all dependencies in a module: qml-browserify -o bundle.js

Bundle and print to the console: qml-browserify -i index.js

Bundle without global variable: qml-browserify --globals

Bundle with Timer pollyfill (see below for setup): qml-browserify --timer

Bundle with Promise pollyfill: qml-browserify --promise

Usage

After bundling, import the bundled js file into your qml with something similar to import 'bundle.js' as Bundle. If you bundled a file you can use Bundle.modules as what you exported from your file (this could be a object, function, etc, depending on what you export). If you bundled your dependencies you can use Bundle.modules and an object containing all the dependencies.

For a complete example, check out the example program in the example directory.

Using the Timer pollyfill

In order to use the Timer pollyfill you have to use a qml Timer component and call Bundle.setupTimeout() with the id of that Timer. This pollyfill is very limited and should be used with caution! For example:

Timer {
  id: timer
  property var callback: function() {}
  interval: 500
  running: false
  repeat: false
  onTriggered: {
    timer.callback();
  }
}

Component.onCompleted: {
  Bundle.setupTimeout(timer);
}

Promise pollyfill

The Promise pollyfill used by qml-browserify is Promise by taylorhakes

License

Copyright (C) 2015 Brian Douglass

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranties of MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.