Fix: Reworked README #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

GhzGarage merged 1 commit into qbcore-framework:main from Cocodrulo:patch-1

Apr 1, 2025

Merged

README.md

-Original file line number
+Diff line change
@@ -1,9 +1,33 @@
-    # qb-input
+    # QBCore Input
     NUI input system for QBCore
     This is a modified version of **[NH Keyboard](https://forum.cfx.re/t/no-longer-supported-standalone-nerohiro-s-keyboard-dynamic-nui-keyboard-input/2506326)** by **[NeroHiro](https://github.com/nerohiro)**
+    ## Input Types
+    - Text
+    - Password
+    - Number
+    - Radio
+    - Checkbox
+    - Select
+    - Color
+    \* All types must be in lowercase
+    ## Input fields
+    | Name | Input Type | Description | Variable Type | Optional | Default Value |
+    | ---- | ---------- | ----------- | ------------- | -------- |  ------------ |
+    | text | All | Text displayed as placeholder/title | `string` | ❌ | ... |
+    | name | All | Variable name in the result (also name of input) | `string` | ❌ | ... |
+    | type | All | Input type | `string` | ✅ | `"text"` |
+    | isRequired | All | Whether the input is required to be filled or not | `boolean` | ✅ | `false` |
+    | default | All | Default input value | `string` | ✅ | `nil` |
+    | options | Radio, Checkbox & Select | Different values that can be selected by the user | `{value: string, text: string}[]` | ❌ | ... |
     ## Example
     Here is an example commant which will create a basic form and will print out it's inputs:
@@ Expand Down @@

Provide feedback