mirror of
https://github.com/CCLeonOS/LeonOS.git
synced 2026-03-03 15:17:01 +00:00
feat(appgui): 添加应用GUI界面支持及包类型管理
新增appgui API用于绘制顶部和底部状态栏,提供一致的UI界面 在package.json中添加type字段区分应用和API包类型 更新安装程序以使用新的appgui界面 修改pkg程序以支持根据包类型安装到不同目录 添加appgui使用文档和演示程序
This commit is contained in:
103
data/computercraft/lua/rom/help/appgui.hlp
Normal file
103
data/computercraft/lua/rom/help/appgui.hlp
Normal file
@@ -0,0 +1,103 @@
|
||||
=== appgui API ===
|
||||
|
||||
The `appgui` API provides simple functions for drawing top bars and bottom bars in LeonOS applications, making it easy to create consistent user interfaces.
|
||||
|
||||
== Introduction ==
|
||||
|
||||
The appgui API is designed to simplify the process of adding professional-looking UI elements to your applications. It provides two main functions for drawing centered text bars at the top or bottom of the screen.
|
||||
|
||||
== Available Functions ==
|
||||
|
||||
- **appgui.topbar(text, [fgColor], [bgColor])**: Draws a top bar with centered text
|
||||
- **appgui.downbar(text, [fgColor], [bgColor])**: Draws a bottom bar with centered text
|
||||
|
||||
== Function Parameters ==
|
||||
|
||||
Both functions accept the following parameters:
|
||||
|
||||
- **text**: (string) The text to display in the bar
|
||||
- **fgColor**: (number, optional) The foreground color (default: white)
|
||||
- **bgColor**: (number, optional) The background color (default: blue)
|
||||
|
||||
== Usage Examples ==
|
||||
|
||||
=== Basic Usage ===
|
||||
|
||||
First, you need to import the appgui module:
|
||||
|
||||
>>color yellow
|
||||
local appgui = require("appgui")
|
||||
>>color white
|
||||
|
||||
Then you can use the functions to draw bars:
|
||||
|
||||
1. Draw a top bar with default colors (white text on blue background):
|
||||
>>color yellow
|
||||
appgui.topbar("My Application Title")
|
||||
>>color white
|
||||
|
||||
2. Draw a bottom bar with default colors:
|
||||
>>color yellow
|
||||
appgui.downbar("Status: Ready")
|
||||
>>color white
|
||||
|
||||
=== Custom Colors ===
|
||||
|
||||
You can specify custom colors using the `colors` module:
|
||||
|
||||
>>color yellow
|
||||
local colors = require("colors")
|
||||
|
||||
-- Red text on yellow background
|
||||
appgui.topbar("Warning Message", colors.red, colors.yellow)
|
||||
|
||||
-- Green text on black background
|
||||
appgui.downbar("Success", colors.green, colors.black)
|
||||
>>color white
|
||||
|
||||
=== Complete Example ===
|
||||
|
||||
Here's a complete example showing how to use both top and bottom bars in an application:
|
||||
|
||||
>>color yellow
|
||||
local appgui = require("appgui")
|
||||
local term = require("term")
|
||||
local colors = require("colors")
|
||||
|
||||
-- Clear the screen
|
||||
term.clear()
|
||||
|
||||
-- Draw top and bottom bars
|
||||
appgui.topbar("My Application")
|
||||
appgui.downbar("Press Q to quit")
|
||||
|
||||
-- Add some content
|
||||
print()
|
||||
print("Welcome to my application!")
|
||||
print()
|
||||
print("This is a demonstration of the appgui API.")
|
||||
print()
|
||||
|
||||
-- Wait for 'Q' key to exit
|
||||
while true do
|
||||
local event, key = os.pullEvent("key")
|
||||
if key == 16 then -- Q key
|
||||
break
|
||||
end
|
||||
end
|
||||
>>color white
|
||||
|
||||
== Notes ==
|
||||
|
||||
- The text will be automatically centered in the bar
|
||||
- The functions will preserve the original terminal colors by saving and restoring them
|
||||
- After drawing a top bar, the cursor will be positioned below the bar
|
||||
- After drawing a bottom bar, the cursor will be positioned at the top of the screen
|
||||
- You can use any colors available in the `colors` module
|
||||
- If the text is longer than the terminal width, it will be truncated
|
||||
|
||||
== See Also ==
|
||||
|
||||
- **colors**: For available color values
|
||||
- **term**: For other terminal manipulation functions
|
||||
- **appgui_demo**: A demonstration program showing the appgui API in action
|
||||
@@ -52,10 +52,33 @@ The package.json file contains metadata about your package. Here's an example:
|
||||
- **version**: The package version (semantic versioning recommended)
|
||||
- **author**: Your name or username
|
||||
- **description**: A short description of what the package does
|
||||
- **type**: The type of your package ("app" for applications, "api" for libraries)
|
||||
- **main**: The main Lua file to load
|
||||
- **dependencies**: Other packages your package depends on
|
||||
- **exports**: Functions or variables to export for other programs to use
|
||||
|
||||
== Package Type Field ==
|
||||
|
||||
The `type` field in package.json determines where your package files will be installed:
|
||||
|
||||
- **app**: Files will be installed in the `/app` directory (default behavior)
|
||||
- **api**: Files will be installed in the `/leonos/apis` directory
|
||||
|
||||
Example of a package.json with type field:
|
||||
|
||||
>>color yellow
|
||||
{
|
||||
"name": "example-api",
|
||||
"version": "1.0.0",
|
||||
"author": "Your Name",
|
||||
"description": "An example API package",
|
||||
"type": "api",
|
||||
"main": "example-api.lua",
|
||||
"dependencies": {},
|
||||
"exports": {}
|
||||
}
|
||||
>>color white
|
||||
|
||||
== Writing Package Code ==
|
||||
|
||||
Edit the `<package_name>.lua` file to add your code. Here's a simple example:
|
||||
|
||||
Reference in New Issue
Block a user