status-desktop/ui/StatusQ
Sale Djenic 2d92be0bfa Necessary updates applied to make it work on mac 2022-09-21 18:20:12 +02:00
..
.github chore: add check for dark and light theme to PR template (#597) 2022-09-21 18:20:08 +02:00
doc feat(StatusCard): Create a new reusbale card component (#731) 2022-09-21 18:20:12 +02:00
sandbox Necessary updates applied to make it work on mac 2022-09-21 18:20:12 +02:00
src feat: use cmake instead of qmake 2022-09-21 18:20:12 +02:00
tests feat: use cmake instead of qmake 2022-09-21 18:20:12 +02:00
vendor bump vendor/SortFilterProxyModel 2022-09-21 18:20:12 +02:00
.gitignore tests(StatusInput): add regression test to check for qml output 2022-09-21 18:20:08 +02:00
.gitmodules chore(git): add vendor/SortFilterProxyModel 2022-09-21 18:20:12 +02:00
CHANGELOG.md
CMakeLists.txt feat: add filtering&sorting example 2022-09-21 18:20:12 +02:00
README.md chore: update README and build script 2022-09-21 18:20:12 +02: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 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
$ ./sandbox/scripts/build

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

$ ./build/sandbox/Sandbox