lvgl/docs/widgets/extra/spinner.md

# Spinner (lv_spinner)

## Overview
The Spinner object is a spinning arc over a ring.

## Parts and Styles
The parts are identical to the parts of [lv_arc](/widgets/core/arc).

## Usage

### Create a spinner

To create a spinner use `lv_spinner_create(parent, spin_time, arc_length)`. `spin time` sets the spin time in milliseconds, `arc_length` sets the length of the spinning arc in degrees.

## Events
No special events are sent to the Spinner.

See the events of the [Arc](/widgets/core/arc) too.

Learn more about [Events](/overview/event).

## Keys
No *Keys* are processed by the object type.

Learn more about [Keys](/overview/indev).


## Example

```eval_rst

.. include:: ../../../examples/widgets/spinner/index.rst

```

## API

```eval_rst

.. doxygenfile:: lv_spinner.h
  :project: lvgl

```
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00			`# Spinner (lv_spinner)`

			`## Overview`
chore(style): remove the trailing space from all source files (#3188) Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com> 2022-03-21 18:25:51 +08:00			`The Spinner object is a spinning arc over a ring.`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			`## Parts and Styles`
docs update some widgets' docs to v8 2021-05-19 13:51:22 +02:00			`The parts are identical to the parts of [lv_arc](/widgets/core/arc).`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			`## Usage`

docs update some widgets' docs to v8 2021-05-19 13:51:22 +02:00			`### Create a spinner`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
Spelling and other language fixes to documentation (#2293) 2021-06-09 15:10:35 +02:00			To create a spinner use `lv_spinner_create(parent, spin_time, arc_length)`. `spin time` sets the spin time in milliseconds, `arc_length` sets the length of the spinning arc in degrees.
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			`## Events`
Simple spelling fixes (#2496) 2021-08-26 10:52:39 +02:00			`No special events are sent to the Spinner.`
docs update some widgets' docs to v8 2021-05-19 13:51:22 +02:00
feat(event, widgets) improve the paramter of LV_EVENT_DRAW_PART_BEGIN/END Add lv_<widget>_draw_part_type_t to widgets to precisly describe the hooked drawings. Also add class_p element to lv_obj_draw_part_dsc_t to show what widgets lv_<widget>_draw_part_type_t needs to be used. Related to: https://forum.lvgl.io/t/how-to-add-minor-division-lines-to-a-chart/5366/ 2021-07-07 16:18:56 +02:00			`See the events of the [Arc](/widgets/core/arc) too.`

fix(docs) minor fixes 2021-05-31 19:42:53 +02:00			`Learn more about [Events](/overview/event).`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			`## Keys`
			`No Keys are processed by the object type.`

			`Learn more about [Keys](/overview/indev).`



			`## Example`

			```eval_rst

docs update some widgets' docs to v8 2021-05-19 13:51:22 +02:00			`.. include:: ../../../examples/widgets/spinner/index.rst`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			```

chore(style): remove the trailing space from all source files (#3188) Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com> 2022-03-21 18:25:51 +08:00			`## API`
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00
			```eval_rst

			`.. doxygenfile:: lv_spinner.h`
			`:project: lvgl`
chore(style): remove the trailing space from all source files (#3188) Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com> 2022-03-21 18:25:51 +08:00
add the md files from the docs repo to start updating them to v8 2021-04-12 18:19:04 +02:00			```