Skip to content

Latest commit

 

History

History
166 lines (110 loc) · 5.34 KB

README.md

File metadata and controls

166 lines (110 loc) · 5.34 KB
Raw

QuickAndroid will be splitted into multiple projects. One of the fork is AndroidNative.pri. It offer native Java components and system service in a more easy installable way. Site: https://github.com/benlau/androidnative.pri

QML Material Design Component and Support Library for Android

Features

  1. Set of UI components implemented Google's Material Design
  2. Support hardware "Back" key nagivation
  3. Dimension in "dp" unit. Auto-scale according to system's DP value.
  4. Provide page transition animation
  5. Drawable Image provider
  6. Load image resource from Android resource style file tree. (e.g drawable-xxxhdpi)
  7. Tint image at load time
  8. Choose the best image according to current resolution automatically.
  9. Messege queue between C++/Qt and Java/Android code
  10. Auto conversion between C++ and Java data type. No need to write in JNI.
  11. Theme / Style Engine
  12. A global Theme object. Set once for all components.
  13. Helper function to create your own derived style.
  14. "Apache license" - Free to use for commerical application

System Requirements

  1. Qt 5.4 or above

UI Components

ActionBar , Button , BottomSheet , Drawable , StateListDrawable
Page , PageStack , MaterialShadow , Text, TextField, DropDownMenu, Paper
TabBar, TabView, FloatingActionButton, ListItem, RaisedButton

Native Components

ImagePicker

Utility Components

InverseMouseArea, RectToRectMatrix, SystemDispatcher, MouseSensor

Installation Instruction (qpm)

For user who are already using qpm from qpm.io

  1. Run qpm install

    qpm install com.github.benlau.quickandroid

  2. Include vendor/vendor.pri in your .pro file

You may skip this step if you are already using qpm

include(vendor/vendor.pri)

Installation Instruction

  1. Download a release and bundle the folder within your source tree.

  2. Add this line to your profile file(.pro):

    include(quickandroid/quickandroid.pri) # You should modify the path by yourself

Java Setup Guide

In order to get native components like image picker, you need to setup the Java environment according to this guide quickandroid/java-setup-guide.md at master · benlau/quickandroid

Demonstration

An example program is available in the folder of tests/quickandroidexample . You may build it by yourself or download the daily build from drone.io .

Remarks: Daily build for non-master branch may not be working.

Screenshot

Class Reference (Under Construction)

Quick Android Class Reference

If you have any question, please feel free to ask.

SystemDispatcher

Automatic type convertion

Qt Java
int int
bool boolean
QString String
QVariantList List
QVariantMap Map

License

Apache License 2.0

TODO

v0.1.7

  1. Migrate to build with gradle
  2. Upgrade min Qt version requirement to 5.5.1

v0.1.8

  1. Upgrade min Qt version requirement to 5.6
  2. Depreate to use A.dp as measurement unit

v1.0

  1. Switch
  2. NavigationDrawer
  3. Slider

Wish

  1. SwipeableListItem
  2. AssetsManager
  3. Haptic Feedback

FAQ

Q. Looking for component that is not supported yet?

Please feel free to submit the request to our issue tracker. Moreover, you may take a look on other component library:

  1. Iktwo/components
  2. rschiang/material

Q. Looking for iOS Native Component?

  1. benlau/quickios

Q. Any library for ...?

  1. Sharing
  2. bdentino/Qtino.SharingKit

Q. How to create splash screen for Android?

See Complete Guide to Making a Splash Screen for your QML Android Application — Medium

Related Projects

Libaries

  1. benlau/quickpromise - Promise library for QML
  2. benlau/quickcross - QML Cross Platform Utility Library
  3. benlau/qsyncable - Synchronize data between models
  4. benlau/testable - QML Unit Test Utilities
  5. benlau/quickflux - Message Dispatcher / Queue for Qt/QML
  6. benlau/biginteger - QML BigInteger library
  7. benlau/qtci - A set of scripts to install Qt in Linux command line environment (e.g travis)
  8. benlau/quickfuture - Using QFuture in QML
  9. benlau/fontawesome.pri - Using FontAwesome in QML

Tools

  1. SparkQML - QML Document Viewer for State and Transition Preview