Reusable Status QML components
Go to file
Alexandra Betouni 825999b151 feat(StatusQ): Moving docs outside sandbox
To generate docs, from doc folder run
/path/to/Qt/installation/bin/qdoc statusq.qdocconf

A folder named "html" will be generated under doc,
open the statusq-index.html to get to the home page.
2022-02-15 08:43:33 +01:00
doc feat(StatusQ): Moving docs outside sandbox 2022-02-15 08:43:33 +01:00
sandbox feat(StatusQ): Moving docs outside sandbox 2022-02-15 08:43:33 +01:00
src fix(StatusQ.Popups): removed overlay setting (#557) 2022-02-15 05:08:15 +02:00
.gitignore chore: ignore cache files 2021-10-18 10:15:16 +02:00
CHANGELOG.md chore: release v0.24.0 2022-02-14 10:02:02 +01:00
README.md feat(StatusChatListAndCategories): add drag and drop support for cate… (#349) 2021-08-26 15:33:45 -04:00
statusq.qrc feat(StatusQ.Components): Adding StatusWizardSteper component 2022-02-09 09:21:46 +01:00

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:

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 sandbox.pro 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/sandbox
$ ./scripts/build

Once that is done, the sandbox can be started with the generated executable:

$ ./bin/sandbox

More Documentation available on the wiki