1# Spinbox (lv_spinbox)
2
3## Overview
4The Spinbox contains a number as text which can be increased or decreased by *Keys* or API functions.
5Under the hood the Spinbox is a modified [Text area](/widgets/core/textarea).
6
7## Parts and Styles
8The parts of the Spinbox are identical to the [Text area](/widgets/core/textarea).
9
10### Value, range and step
11`lv_spinbox_set_value(spinbox, 1234)` sets a new value on the Spinbox.
12
13`lv_spinbox_increment(spinbox)` and `lv_spinbox_decrement(spinbox)` increments/decrements the value of the Spinbox according to the currently selected digit.
14
15`lv_spinbox_set_range(spinbox, -1000, 2500)` sets a range. If the value is changed by `lv_spinbox_set_value`, by *Keys*,`lv_spinbox_increment/decrement` this range will be respected.
16
17`lv_spinbox_set_step(spinbox, 100)` sets which digits to change on increment/decrement. Only multiples of ten can be set, and not for example 3.
18
19`lv_spinbox_set_cursor_pos(spinbox, 1)` sets the cursor to a specific digit to change on increment/decrement. For example position '0' sets the cursor to the least significant digit.
20
21If an encoder is used as input device, the selected digit is shifted to the right by default whenever the encoder button is clicked. To change this behaviour to shifting to the left, the `lv_spinbox_set_digit_step_direction(spinbox, LV_DIR_LEFT)` can be used
22
23### Format
24
25`lv_spinbox_set_digit_format(spinbox, digit_count, separator_position)` sets the number format. `digit_count` is the number of digits excluding the decimal separator and the sign.
26`separator_position` is the number of digits before the decimal point. If 0, no decimal point is displayed.
27
28### Rollover
29`lv_spinbox_set_rollover(spinbox, true/false)` enables/disabled rollover mode. If either the minimum or maximum value is reached with rollover enabled, the value will change to the other limit. If rollover is disabled the value will remain at the minimum or maximum value.
30
31## Events
32- `LV_EVENT_VALUE_CHANGED` Sent when the value has changed.
33
34See the events of the [Text area](/widgets/core/textarea) too.
35
36Learn more about [Events](/overview/event).
37
38## Keys
39- `LV_KEY_LEFT/RIGHT` With *Keypad* move the cursor left/right. With *Encoder* decrement/increment the selected digit.
40- `LV_KEY_UP/DOWN` With *Keypad* and *Encoder* increment/decrement the value.
41- `LV_KEY_ENTER` With *Encoder* got the net digit. Jump to the first after the last.
42
43## Example
44
45```eval_rst
46
47.. include:: ../../../examples/widgets/spinbox/index.rst
48
49```
50
51## API
52
53```eval_rst
54
55.. doxygenfile:: lv_spinbox.h
56  :project: lvgl
57
58```
59## Example
60