> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/wifi-pineapple-pager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/wifi-pineapple-pager/number_picker.md).

# NUMBER\_PICKER

`NUMBER_PICKER` Ask the user to interactively ender a number via the UI

### When to use it <a href="#when-to-use-it" id="when-to-use-it"></a>

`NUMBER_PICKER` presents an optimized numerical keyboard whenever a payload needs a number, such as a port or a timeout value. It is a quicker way to ask the user for nunbers - and only numbers - than the `TEXT_PICKER` interface.

#### Syntax <a href="#syntax" id="syntax"></a>

```none
NUMBER_PICKER [text prompt] [default number]
```

**text prompt&#x20;*****required***

Text prompt / dialog title shown to the user. Text prompts should be kept short enough to fit on the device display.

**default number&#x20;*****required***

Default number pre-populated when the number picker launches. Must be an empty string (`""`) for a blank prompt.

{% hint style="warning" %}
A default number must always be provided, even if it is blank.
{% endhint %}

<figure><img src="/files/zVAVxba0Sf5ExkYmfIbM" alt="The number picker dialog"><figcaption><p>The number picker dialog</p></figcaption></figure>

<figure><img src="/files/KymXvNn4YBH9ERwUsyzE" alt="The number picker editor"><figcaption><p>The number picker editor</p></figcaption></figure>

### Results <a href="#results" id="results"></a>

`NUMBER_PICKER` will wait until the user has made a selection, pausing the payload.

`NUMBER_PICKER` exits with a return code of 0 if the user enters a value, and non-zero if the user cancels.

`NUMBER_PICKER` returns the number as the output

### Examples <a href="#examples" id="examples"></a>

```bash
__usernum=$(NUMBER_PICKER "Timeout (in seconds)" "5") || exit 0
```

```bash
__usernum=$(NUMBER_PICKER "No default number" "") || exit 0
```

{% hint style="info" %}
Remember to enclose the prompt text in quotes if it contains spaces!
{% endhint %}
