status-desktop/ui/StatusQ
Pascal Precht 78ed4642d6 chore: ensure `StatusChatList` receives the proper value for mentions
This is due to a change in how mentions and unread messages are indicated.
See 7fbccec227 for more information.
2022-09-21 18:20:03 +02:00
..
sandbox chore: ensure `StatusChatList` receives the proper value for mentions 2022-09-21 18:20:03 +02:00
src chore: ensure `StatusChatList` receives the proper value for mentions 2022-09-21 18:20:03 +02:00
.gitignore fix: Add missing .qml to resources, add qmlcache to gitignore 2022-09-21 18:20:02 +02:00
README.md chore(README): re-add sandbox app instructions 2022-09-21 18:20:02 +02:00
statusq.qrc feat(Controls): introduce StatusBaseInput 2022-09-21 18:20:02 +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 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