status-desktop/ui/StatusQ
Michał Cieślak 0cba5eccbd feat(StatusQ/Utils): Add StringUtils to expose string-related C++ routines
So far methods like escapeHtml were available via backend, creating
unnecessary dependency on backing in UI components.
2023-08-18 17:07:20 +02:00
..
doc feat(Communities): changes in import popup for private keys 2023-08-07 15:26:35 +03:00
include/StatusQ feat(StatusQ/Utils): Add StringUtils to expose string-related C++ routines 2023-08-18 17:07:20 +02:00
sandbox fix(StatusQ): Allow two lines text content in StatusToastMessage 2023-07-28 10:03:10 +03:00
sanity_checker fix(StatusQ): StatusQ is QML module (#10207) 2023-04-14 11:18:56 +03:00
scripts fix(StatusQ/Sandbox): move and update build script 2023-02-20 20:36:05 +01:00
src feat(StatusQ/Utils): Add StringUtils to expose string-related C++ routines 2023-08-18 17:07:20 +02:00
tests fix(Sandbox): Fixed hot reloading. Fixed MacOS arm64 builds. (#10562) 2023-05-05 19:05:44 +03:00
CHANGELOG.md chore: remove dictionary 2023-06-09 14:50:08 -04:00
CMakeLists.txt feat(StatusQ/Utils): Add StringUtils to expose string-related C++ routines 2023-08-18 17:07:20 +02:00
README.md fix(StatusQ/Sandbox): move and update build script 2023-02-20 20:36:05 +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 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