clui/README.md

38 lines
1.8 KiB
Markdown
Raw Normal View History

2015-09-19 02:16:56 +08:00
# clui
2015-11-25 09:47:33 +08:00
Command Line User Interface (Console UI inspired by TurboVision) with built-in theme support.
2015-09-29 06:43:40 +08:00
2015-09-19 10:41:30 +08:00
## Introduction
2015-11-25 09:47:33 +08:00
The list of available controls:
2015-11-25 09:51:06 +08:00
* View (Main control container - with maximize, window order and other window features)
2015-11-25 09:47:33 +08:00
* Label (Horizontal and Vertical with basic color control tags)
* Button (Simple push button control)
* EditFiled (One line text edit control with basic clipboard control)
* ListBox (string list control with vertical scroll)
* TextView (ListBox-alike control with vertical and horizontal scroll, and wordwrap mode)
* ProgressBar (Vertical and horizontal. The latter one supports custom text over control)
* Frame (A decorative control that can be a container for other controls as well)
* CheckBox (Simple check box)
* Radio (Simple radio button. Useless alone - should be used along with RadioGroup)
* RadioGroup (Non-visual control to manage a group of a few RadioButtons)
2015-11-25 09:51:06 +08:00
* ConfirmationDialog (modal View to ask a user confirmation, button titles are custom)
* SelectDialog (modal View to ask a user to select an item from the list - list can be ListBox or RadioGroup)
2015-12-11 06:02:11 +08:00
* BarChart (Horizontal bar chart without scroll)
2015-12-15 08:16:13 +08:00
* SparkChart (Show tabular data as a bar graph)
2015-12-29 06:26:31 +08:00
* GridView (Table to show structured data - only virtual and readonly mode with scroll support)
2015-11-25 09:47:33 +08:00
2015-11-25 09:51:06 +08:00
#### TODO
2015-12-29 06:26:31 +08:00
* More to come
2015-09-19 10:41:30 +08:00
## Screenshots
2016-06-24 01:35:46 +08:00
The main demo (theme changing and radio group control)
<img src="./demos/clui_demo_main.gif" alt="Main Demo">
2015-10-17 01:19:36 +08:00
The screencast of demo (based on custom termbox-go Window build) included in the library:
2015-09-19 10:41:30 +08:00
<img src="./demos/demo.gif" alt="Library Demo">
The library is in the very beginning but it can be used to create working utilities: below is the example of my Dilbert comix downloader:
<img src="./demos/dilbert_demo.gif" alt="Dilbert Downloader">