josh/ReJUI
2
0
Fork 0
Code Issues 60 Pull Requests Actions Packages Projects 1 Releases 29 Wiki Activity

Test of links to supplemental documentation.

Browse Source
This commit is contained in:
dawsh
2025-06-16 01:35:54 -05:00
parent fa5b9e23cf
commit 80682e5fee
3 changed files with 48 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -15,24 +15,7 @@ It is expressly built with our Redacted3D engine in mind, but steps have been ta
JUI provides a set of objects that we term Widgets, which can be styled and laid out on-screen in relation to each other. Each widget has a single parent, and a list of child elements. Your root widget should be a Scene object. JUI provides a set of objects that we term Widgets, which can be styled and laid out on-screen in relation to each other. Each widget has a single parent, and a list of child elements. Your root widget should be a Scene object.
## Features ## Features
* Comprehensive list of common UI widgets: * Flexible and comprehensive set of Widgets. [Full List Here](docs/widgets.md)
* ![Scene](https://git.redacted.cc/josh/ReJUI/wiki/Scene)
* ![Rect](https://git.redacted.cc/josh/ReJUI/wiki/Rect)
* ![Text](https://git.redacted.cc/josh/ReJUI/wiki/Text)
* ![TextRect](https://git.redacted.cc/josh/ReJUI/wiki/TextRect)
* ![Button](https://git.redacted.cc/josh/ReJUI/wiki/Button)
* ![TextButton](https://git.redacted.cc/josh/ReJUI/wiki/TextButton)
* ![TextInputForm](https://git.redacted.cc/josh/ReJUI/wiki/TextInputForm)
* ![Slider](https://git.redacted.cc/josh/ReJUI/wiki/Slider)
* ![Image](https://git.redacted.cc/josh/ReJUI/wiki/Image)
* ![ImageRect](https://git.redacted.cc/josh/ReJUI/wiki/ImageRect)
* ![RadioButton](https://git.redacted.cc/josh/ReJUI/wiki/RadioButton)
* ![Window](https://git.redacted.cc/josh/ReJUI/wiki/Window)
* ![Checkbox](https://git.redacted.cc/josh/ReJUI/wiki/Checkbox)
* ![NineSliceRect](https://git.redacted.cc/josh/ReJUI/wiki/NineSliceRect)
* Vertical and Horizontal ListLayout, GridLayout
* Separator
* ScrollRect
* Extendable - Widgets can be extended via class derivation, and even combined to create complex behavior. * Extendable - Widgets can be extended via class derivation, and even combined to create complex behavior.
* Low-overhead stateful GUI elements. * Low-overhead stateful GUI elements.
* Easy integration with your project. Simply provide update, draw, and user-input callbacks to your scene. * Easy integration with your project. Simply provide update, draw, and user-input callbacks to your scene.
@@ -58,6 +41,10 @@ Currently, the package is also integrated with ![J3ML](https://git.redacted.cc/j
Documentation is automatically generated from latest commit and is hosted at https://doc.redacted.cc/jui . Documentation is automatically generated from latest commit and is hosted at https://doc.redacted.cc/jui .
[An overview of the library is available here.](docs/overview.md)
[A full list of widgets is available here.](docs/widgets.md)
## Contributing ## Contributing
Contributions to JUI are welcome! Feel free to file bug reports or feature requests by creating an Issue. Pull requests are also very welcome! Contributions to JUI are welcome! Feel free to file bug reports or feature requests by creating an Issue. Pull requests are also very welcome!

0
docs/overview.md Normal file
View File

43
docs/widgets.md Normal file
View File

@@ -0,0 +1,43 @@
<details>
<summary>Widget</summary>
This is some information about the Widget class.
</details>
<details>
<summary>BindMenu</summary>
This is some information about the Widget class.
</details>
<details>
<summary>Button</summary>
This is some information about the Widget class.
</details>
<details><summary>Checkbox</summary>
This is some information about the Widget class.
</details>
<details><summary>Collapsible</summary>
This is some information about the Widget class.
</details>
<details><summary>ColorPicker</summary>
This is some information about the Widget class.
</details>
<details><summary>ComboBox</summary>
This is some information about the Widget class.
</details>
<details><summary>CommandLine</summary>
This is some information about the Widget class.
</details>
<details><summary>ContextMenu</summary>
This is some information about the Widget class.
</details>