> For the complete documentation index, see [llms.txt](https://docs.qbcore.org/qbcore-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-input.md).

# qb-input

## Introduction

The **QB Input** system provides an interactive Lua-based user input form integrated with a web-based interface

### Features

* Multiple input types (text, password, number, radio, select, checkbox, color)
* Customizable form submission
* Dynamic styling through configuration
* Easy-to-use Lua and JavaScript integration

## ShowInput

Displays an input form and returns user input data.

* data: `table`
  * header :*`string` (optional)*
  * submitText:*`string` (optional)*
  * inputs: `table`
    * type: *`string`*
    * name: *`string`*
    * text: *`string`*
    * default: *`any` (optional)*
    * isRequired: *`boolean` (optional)*
    * options: *`table` (optional)*
      * text: *`string`*
      * value: *`string`*
      * checked: *`boolean` (optional)*

```lua
RegisterCommand('testinput', function()
    local dialog = exports['qb-input']:ShowInput({
        header = "Test",
        submitText = "Bill",
        inputs = {
            {
                text = "Citizen ID (#)",
                name = "citizenid",
                type = "text",
                isRequired = true,
                default = "CID-1234",
            },
            {
                text = "Secret Code (Give to Nobody)",
                name = "code",
                type = "password",
                isRequired = true,
                default = "password123",
            },
            {
                text = "Bill Price ($)",
                name = "billprice",
                type = "number",
                isRequired = false,
                default = 1,
            },
            {
                text = "Bill Type",
                name = "billtype",
                type = "radio",
                options = {
                    { value = "bill", text = "Bill" },
                    { value = "cash", text = "Cash" },
                    { value = "bank", text = "Bank" }
                },
                default = "cash",
            },
            {
                text = "Include Tax?",
                name = "taxincl",
                type = "checkbox",
                options = {
                    { value = "gst", text = "10% incl."},
                    { value = "business", text = "35% incl.", checked = true },
                    { value = "othertax", text = "15% incl."}
                }
            },
            {
                text = "Some Select",
                name = "someselect",
                type = "select",
                options = {
                    { value = "none", text = "None" },
                    { value = "other", text = "Other"},
                    { value = "other2", text = "Other2" },
                    { value = "other3", text = "Other3" },
                    { value = "other4", text = "Other4" },
                    { value = "other5", text = "Other5" },
                    { value = "other6", text = "Other6" },
                },
                default = "other3",
            },
            {
                text = "Favorite Color",
                name = "favoritecolor",
                type = "color",
                default = "#ff0000",
            }
        }
    })

    if dialog ~= nil then
        for k,v in pairs(dialog) do
            print(k .. " : " .. v)
        end
    end
end, false)
```

## CloseMenu

Closes the menu

```lua
exports['qb-input']:CloseMenu()
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-input.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.