qui 0.5.0
A Text User Interface library.
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
QUI
QUI is a widget based Text User Interface library for the D Language.
Features
- Widget-based
- Easy to add more widgets
- Widgets are isolated, each widget draws in it's own "area"
- Easy to get started with (
source/demo.d
explains how to use most of it) - Event-based
- Timer Events, the timer duration can be changed
- Support for mouse events
- Most, if not all, of the code is commented
- Unicode characters supported
Setting it up
To use qui in your dub package, run this in your dub package's directory:
dub add qui
qui also uses utils
package, and you will also need it in your package, so you also need to do:
dub add utils
and add following import to your code.
import utils.misc : uinteger, integer;
Getting Started
All the widgets are contained in qui.widgets
, and the base classes are in qui.qui
.
You should also read through docs/*.md
for a quick start on how to use and write new widgets.
Building demo
The included demo configuration (source/demo.d
) demonstrates the usage of some of the included widgets. To build & run it, run the following:
dub fetch qui
dub run qui --b=release --c=quidemo
Documentation
See docs/
for documentation on how to use qui and how to write widgets.
Additionally, you could also see source/qui/widgets.d
and see some existing widgets, this can be helpful in writing new widgets.
Known Issues
See the issues tab. If you came across some new issue, start a new one.
TODO for upcoming versions
- Have
QLayout
manage scrolling of long widgets instead of implementing it in each widget
License
QUI is licensed under the MIT license - see LICENSE.
QUI uses Adam D. Ruppe's terminal.d which is licensed under the Boost License - see source/arsd/LICENSE
.
- Registered by Nafees Hassan
- 0.5.0 released 4 years ago
- Nafees10/qui
- MIT
- Copyright © 2017-2020, Nafees Hassan
- Authors:
- Dependencies:
- utils
- Versions:
-
0.7.1 2023-Apr-22 0.7.0 2023-Apr-12 0.6.2 2023-Jan-12 0.6.1 2022-Oct-16 0.6.0-alpha2 2022-Oct-16 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
0 downloads this month
-
316 downloads total
-
- Score:
- 1.1
- Short URL:
- qui.dub.pm