ToolJet/docs/versioned_docs/version-2.4.0/widgets/number-input.md

107 lines
3.7 KiB
Markdown
Raw Normal View History

---
id: number-input
title: Number Input
---
# Number Input
Number Input widget lets users enter and change numbers.
## How To Use Number Input Widget
<iframe height="500" src="https://www.youtube.com/embed/Xf9Sx2fNzng" title="Number InputWidget" frameborder="0" allowfullscreen width="100%"></iframe>
:::tip
Numbers can be changed by using the arrow keys.
:::
## Properties
### Default value
A predefined value that can be fetched from the number input widget if no changes are made in widget.
### Minimum value
It specifies the minimum value the number input can go to. This field accepts any numerical value.
### Maximum value
It specifies the maximum value the number input can go to. This field accepts any numerical value.
### Placeholder
It specifies a hint that describes the expected value. This field accepts any numerical value.
## Events
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/widgets/number-input/event.png" alt="Events-Number Input" />
</div>
### On change
This event fires whenever the value of the number input widget is changed.
:::info
Check [Action Reference](/docs/category/actions-reference) docs to get the detailed information about all the **Actions**.
:::
## General
### Tooltip
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget. Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/tooltip.png" alt="Events-Number Input" />
</div>
## Layout
### Show on desktop
Toggle on or off to display the widget in desktop view. You can programmatically determine the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}`.
### Show on mobile
Toggle on or off to display the widget in mobile view. You can programmatically determine the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}`.
## Styles
### Visibility
Toggle on or off to control the visibility of the widget. You can programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget will not be visible after the app is deployed. By default, it's set to `{{true}}`.
### Disable
This is `off` by default, toggle `on` the switch to lock the widget and make it non-functional. You can also programmatically set the value by clicking on the `Fx` button next to it. If set to `{{true}}`, the widget will be locked and becomes non-functional. By default, its value is set to `{{false}}`.
### Border radius
Add a border radius to the number input widget using this property. It accepts any numerical value from `0` to `100`.
### Border color
Change the border color number-input component by entering the Hex color code or choosing a color of your choice from the color picker.
### Background color
Change the background color of the number-input component by entering the Hex color code or choosing a color of your choice from the color picker.
### Text color
Change the color of the number in number-input component by entering the Hex color code or choosing a color of your choice from the color picker.
:::info
Any property having `Fx` button next to its field can be **programmatically configured**.
:::
## Exposed variables
| Variables | Description |
| ----------- | ----------- |
| value | This variable updates whenever a user selects a number on the number input. You can access the value dynamically using JS: `{{components.numberinput1.value}}`|
## Component specific actions (CSA)
There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.