3c18ac0f7a
- it's easier to make sure and detect what users are using, esp. when they report bugs - with a clickable link to the release notes |
||
|---|---|---|
| .. | ||
| doc | ||
| include/StatusQ | ||
| sandbox | ||
| sanity_checker | ||
| scripts | ||
| src | ||
| tests | ||
| CHANGELOG.md | ||
| CMakeLists.txt | ||
| README.md | ||
README.md
StatusQ
An emerging reusable QML UI component library for Status applications.
Usage
StatusQ introduces a module namespace that semantically groups components so they can be easily imported. These modules are:
- StatusQ.Core
- StatusQ.Core.Theme
- StatusQ.Core.Utils
- StatusQ.Components
- StatusQ.Controls
- StatusQ.Layout
- StatusQ.Platform
- StatusQ.Popups
Provided components can be viewed and tested in the sandbox application that comes with this repository. Other than that, modules and components can be used as expected.
Example:
import Status.Core 0.1
import Status.Controls 0.1
StatusInput {
...
}
Viewing and testing components
To make viewing and testing components easy, we've added a sandbox application to this repository in which StatusQ components are being build. This is the first place where components see the light of the world and can be run in a proper application environment.
Using Qt Creator
The easiest way to run the sandbox application is to simply open the provided CMakeLists.txt file using Qt Creator.
Using command line interface
To run the sandbox from within a command line interface, run the following commands:
$ git clone https://github.com/status-im/StatusQ
$ cd StatusQ
$ git submodule update --init
$ ./scripts/build
Once that is done, the sandbox can be started with the generated executable:
$ ./build/sandbox/Sandbox