lvgl

(★ 24,436)

LVGL is a free, full-featured embedded UI library for devices from small MCUs to 3D-capable MPUs, enhanced by LVGL Pro, a professional editor and tooling.

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- __build_all.sh__
- __c_cpp_properties.json__
- __CMakeLists.txt__
- __main.c__
- __settings.json__
- devcontainer.json
- Dockerfile
- lv_conf.defaults
- lvgl_shell.html
- setup.sh
- - c-code.instructions.md
- - bug-report.yml
  - config.yml
  - dev-discussion.yml
  - feat-planning.yml
- - arduino.yml
  - build_examples_with_cxx_compiler.yml
  - build_hardware.yml
  - build_micropython.yml
  - ccpp.yml
  - check_bom.yml
  - check_cppcheck.yml
  - check_gdb_consts.yml
  - check_pr_title.yml
  - check_properties.yml
  - check_style.yml
  - check_templ.yml
  - code_generation.yml
  - compile_docs.yml
  - debian.yml
  - distribution.yml
  - esp_upload_component.yml
  - gen_json.yml
  - install.yml
  - main.yml
  - makefiles.yml
  - makefiles_uefi.yml
  - perf_emulation.yml
  - perf_emulation_handle_results.yml
  - perf_hardware.yml
  - perf_hardware_comment_pr.yml
  - perf_tests.yml
  - platformio_publish.yaml
  - release.yml
  - release_branch_updater.yml
  - stale_bot.yml
  - static_checks.yml
  - verify_font_license.yml
  - verify_kconfig.yml
- .codecov.yml
- auto-comment.yml
- CODEOWNERS
- copilot-instructions.md
- dependabot.yml
- FUNDING.yml
- pull_request_template.md
- - drm-3d.defconfig
  - drm.defconfig
  - empty.defconfig
  - linux-3d.defconfig
  - linux.defconfig
  - sdl2-3d.defconfig
  - sdl2.defconfig
  - wayland-3d.defconfig
  - wayland.defconfig
- - Kconfig
  - lv_demo_benchmark.c
  - lv_demo_benchmark.h
  - screenshot1.png
  - screenshot2.png
- - Kconfig
  - lv_demo_gltf.c
  - lv_demo_gltf.h
- - Kconfig
  - lv_demo_keypad_encoder.c
  - lv_demo_keypad_encoder.h
  - README.md
  - screenshot1.gif
  - screenshot1.png
- - Kconfig
  - lv_demo_music.c
  - lv_demo_music.h
  - lv_demo_music_list.c
  - lv_demo_music_list.h
  - lv_demo_music_main.c
  - lv_demo_music_main.h
  - README.md
  - screenshot1.gif
- - Kconfig
  - lv_demo_render.c
  - lv_demo_render.h
- - Kconfig
  - lv_demo_stress.c
  - lv_demo_stress.h
  - README.md
  - screenshot1.gif
  - screenshot1.png
- - Kconfig
  - lv_demo_vector_graphic.c
  - lv_demo_vector_graphic.h
- - Kconfig
  - lv_demo_widgets.c
  - lv_demo_widgets.h
  - lv_demo_widgets.py
  - lv_demo_widgets_analytics.c
  - lv_demo_widgets_analytics.h
  - lv_demo_widgets_components.c
  - lv_demo_widgets_components.h
  - lv_demo_widgets_profile.c
  - lv_demo_widgets_profile.h
  - lv_demo_widgets_shop.c
  - lv_demo_widgets_shop.h
  - screenshot1.gif
  - screenshot1.png
- Kconfig
- lv_demos.c
- lv_demos.h
- README.md
- - index.mdx
  - meta.json
  - xml.mdx
- .gitignore
- build_docs.py
- CODE_OF_CONDUCT.md
- Doxyfile
- README.md
- README_he.md
- README_ja.md
- README_ko.md
- README_pt_BR.md
- README_zh.md
- xml_to_md.py
- - dependencies.cmake
  - esp.cmake
  - kconfig.cmake
  - lvgl.pc.in
  - lvgl_link_libraries.cmake
  - lvgl_target_definitions.cmake
  - lvglConfig.cmake.in
  - main.cmake
  - micropython.cmake
  - version.cmake
- - gen_pack.sh
  - lv_cmsis_pack.txt
  - lv_conf_cmsis.h
  - lv_os_custom_c.txt
  - lv_os_custom_h.txt
  - LVGL.lvgl.9.5.0.pack
  - LVGL.lvgl.pdsc
  - LVGL.pidx
  - README.md
- - changelog
  - control
  - copyright
  - Dockerfile
  - extract-build-deps.py
  - rules
- - Kconfig.build
  - Kconfig.compiler
- - pika_lv_point_t.c
  - pika_lv_timer_t.c
  - pika_lv_wegit.c
  - pika_lvgl.c
  - pika_lvgl.pyi
  - pika_lvgl_indev_t.c
  - pika_lvgl_lv_event.c
  - pika_lvgl_lv_obj.c
  - pika_lvgl_lv_style_t.c
  - README.md
- - common.mk
  - Makefile
- - lv_rt_thread_conf.h
  - lv_rt_thread_port.c
  - SConscript
- - about.md
  - lv_example_anim.h
  - lv_example_anim_1.c
  - lv_example_anim_2.c
  - lv_example_anim_3.c
  - lv_example_anim_4.c
  - lv_example_anim_timeline_1.c
- - animimg001.c
  - animimg001.png
  - animimg002.c
  - animimg002.png
  - animimg003.c
  - animimg003.png
  - caret_down.png
  - circle.svg
  - font_example_large.c
  - img_arc_bg.c
  - img_arc_bg.png
  - img_arc_indicator.c
  - img_arc_indicator.png
  - img_bar_bg.c
  - img_bar_bg.png
  - img_bar_indicator.c
  - img_bar_indicator.png
  - img_caret_down.c
  - img_caret_down.png
  - img_cogwheel_argb.c
  - img_cogwheel_argb.png
  - img_cogwheel_chroma_keyed.png
  - img_cogwheel_indexed16.c
  - img_cogwheel_indexed16.png
  - img_cogwheel_rgb.c
  - img_cogwheel_rgb.png
  - img_example_lvgl_logo.c
  - img_example_lvgl_logo.png
  - img_hand.c
  - img_hand_hour.png
  - img_hand_min.png
  - img_multilang_like.c
  - img_multilang_like.png
  - img_skew_strip.c
  - img_skew_strip.png
  - img_skew_strip_80x20_argb8888.fnt
  - img_star.c
  - img_star.png
  - img_strip.png
  - img_svg_img.c
  - img_transform_avatar_15.c
  - img_transform_avatar_15.png
  - imgbtn_left.c
  - imgbtn_left.png
  - imgbtn_mid.c
  - imgbtn_mid.png
  - imgbtn_right.c
  - imgbtn_right.png
- - about.md
  - lv_example_event.h
  - lv_example_event_bubble.c
  - lv_example_event_button.c
  - lv_example_event_click.c
  - lv_example_event_draw.c
  - lv_example_event_streak.c
  - lv_example_event_trickle.c
- - about.md
  - lv_example_get_started.h
  - lv_example_get_started_button.c
- - about.md
  - lv_example_grad.h
  - lv_example_grad_1.c
  - lv_example_grad_2.c
  - lv_example_grad_3.c
  - lv_example_grad_4.c
- - about.md
  - lv_example_layout.h
- - about.md
  - lv_example_libs.h
- - about.md
  - lv_example_others.h
- - about.md
  - lv_port_disp_template.c
  - lv_port_disp_template.h
  - lv_port_fs_template.c
  - lv_port_fs_template.h
  - lv_port_indev_template.c
  - lv_port_indev_template.h
  - lv_port_lcd_stm32_template.c
  - lv_port_lcd_stm32_template.h
- - about.md
  - lv_example_scroll.h
  - lv_example_scroll_chain.c
  - lv_example_scroll_chain.xml
  - lv_example_scroll_circular.c
  - lv_example_scroll_events.c
  - lv_example_scroll_floating.c
  - lv_example_scroll_floating.xml
  - lv_example_scroll_infinite.c
  - lv_example_scroll_one.c
  - lv_example_scroll_one.xml
  - lv_example_scroll_overview.c
  - lv_example_scroll_overview.xml
  - lv_example_scroll_properties.c
  - lv_example_scroll_rtl.c
  - lv_example_scroll_rtl.xml
  - lv_example_scroll_scrollable.c
  - lv_example_scroll_scrollable.xml
  - lv_example_scroll_scrollbar_mode.c
  - lv_example_scroll_scrollbar_mode.xml
  - lv_example_scroll_scrollbar_style.c
  - lv_example_scroll_scrollbar_style.xml
  - lv_example_scroll_snap.c
  - lv_example_scroll_snap.xml
  - lv_example_scroll_to.c
  - lv_example_scroll_translate.c
- - about.md
  - lv_example_style.h
  - lv_example_style_arc.c
  - lv_example_style_arc.xml
  - lv_example_style_background.c
  - lv_example_style_background.xml
  - lv_example_style_blur.c
  - lv_example_style_blur.xml
  - lv_example_style_border.c
  - lv_example_style_border.xml
  - lv_example_style_drop_shadow.c
  - lv_example_style_drop_shadow.xml
  - lv_example_style_gradient_buttons.c
  - lv_example_style_gradient_conic.c
  - lv_example_style_gradient_radial.c
  - lv_example_style_image.c
  - lv_example_style_image.xml
  - lv_example_style_line.c
  - lv_example_style_line.xml
  - lv_example_style_local.c
  - lv_example_style_local.xml
  - lv_example_style_margin.c
  - lv_example_style_margin.xml
  - lv_example_style_modal.c
  - lv_example_style_multiple.c
  - lv_example_style_multiple.xml
  - lv_example_style_opacity_transform.c
  - lv_example_style_opacity_transform.xml
  - lv_example_style_outline.c
  - lv_example_style_outline.xml
  - lv_example_style_padding.c
  - lv_example_style_padding.xml
  - lv_example_style_parts_states.c
  - lv_example_style_parts_states.xml
  - lv_example_style_shadow.c
  - lv_example_style_shadow.xml
  - lv_example_style_size_position.c
  - lv_example_style_size_position.xml
  - lv_example_style_text.c
  - lv_example_style_text.xml
  - lv_example_style_theme.c
  - lv_example_style_transform_card.c
  - lv_example_style_transition.c
  - lv_example_styles.h
- - about.md
  - lv_example_widgets.h
- - .gitignore
  - globals.xml
  - project.xml
- about.md
- header.py
- Kconfig
- lv_examples.h
- lv_examples_api_map.h
- README.md
- test_ex.sh
- - lv_types.h
  - lv_version.h
  - lvgl.h
- - lvgl_private.h
- lvgl.spdx.json
- README.md
- requirements.txt
- third_party.json
- - kconfig.py
  - lv_conf_header.py
  - lv_conf_preprocess_cc.py
  - lv_conf_preprocess_pcpp.py
  - preprocess_lv_conf_internal.py
- - built_in_font_gen.py
  - DejaVuSans.ttf
  - FontAwesome5-Solid+Brands+Regular.woff
  - generate_all.py
  - Montserrat-Medium.ttf
  - SourceHanSansSC-Normal.otf
  - unscii-8.ttf
- - .gitignore
  - .python-version
  - gdbinit.py
  - pyproject.toml
  - README.md
  - requirements.txt
- - create_fake_lib_c.py
  - gen_json.py
  - get_sdl2.py
  - pycparser_monkeypatch.py
  - requirements.txt
- - config_files.py
  - style_api.py
- - benchmark_results_comment.py
  - filter_docker_benchmark_logs.py
  - lvperf_dependencies.sh
  - serialize_results.py
- - check_headers.py
  - check_lv_types.py
- .gitignore
- build_html_examples.sh
- changelog-template.hbs
- changelog_gen.sh
- check_cppcheck.py
- check_doc_links.py
- check_gcov_coverage.py
- cleanup_examples.py
- code-format.cfg
- code-format.py
- commit_msg_check.py
- cppcheck_run.sh
- filetohex.py
- find_version.sh
- font_license_verify.py
- generate_cmake_variables.py
- generate_copyrights.py
- generate_examples.py
- generate_lv_conf.py
- generate_sbom.py
- genexamplelist.sh
- image_viewer.py
- infer_run.sh
- install-prerequisites.bat
- install-prerequisites.sh
- install_astyle.sh
- install_pngquant.sh
- jpg_to_sjpg.py
- kconfig_verify.py
- lv_templ_check.py
- lvgl_cppcheck.cfg
- LVGLImage.py
- prerequisites-apt.txt
- prerequisites-pip.txt
- properties.py
- release_branch_updater.py
- release_branch_updater_port_urls.txt
- run_tests.sh
- run_tests_docker.sh
- trace_filter.py
- update_version.py
- validate_sbom.py
- - Kconfig
  - lv_global.h
  - lv_group.c
  - lv_group.h
  - lv_group_private.h
  - lv_obj.c
  - lv_obj.h
  - lv_obj_class.c
  - lv_obj_class.h
  - lv_obj_class_private.h
  - lv_obj_draw.c
  - lv_obj_draw.h
  - lv_obj_draw_private.h
  - lv_obj_event.c
  - lv_obj_event.h
  - lv_obj_event_private.h
  - lv_obj_id_builtin.c
  - lv_obj_pos.c
  - lv_obj_pos.h
  - lv_obj_private.h
  - lv_obj_property.c
  - lv_obj_property.h
  - lv_obj_scroll.c
  - lv_obj_scroll.h
  - lv_obj_scroll_private.h
  - lv_obj_style.c
  - lv_obj_style.h
  - lv_obj_style_gen.c
  - lv_obj_style_gen.h
  - lv_obj_style_private.h
  - lv_obj_tree.c
  - lv_obj_tree.h
  - lv_observer.c
  - lv_observer.h
  - lv_observer_private.h
  - lv_refr.c
  - lv_refr.h
  - lv_refr_private.h
- - Kconfig
- - lv_display.c
  - lv_display.h
  - lv_display_private.h
- - Kconfig
  - lv_draw.c
  - lv_draw.h
  - lv_draw_3d.c
  - lv_draw_3d.h
  - lv_draw_arc.c
  - lv_draw_arc.h
  - lv_draw_blur.c
  - lv_draw_blur.h
  - lv_draw_buf.c
  - lv_draw_buf.h
  - lv_draw_buf_private.h
  - lv_draw_image.c
  - lv_draw_image.h
  - lv_draw_image_private.h
  - lv_draw_label.c
  - lv_draw_label.h
  - lv_draw_label_private.h
  - lv_draw_line.c
  - lv_draw_line.h
  - lv_draw_mask.c
  - lv_draw_mask.h
  - lv_draw_private.h
  - lv_draw_rect.c
  - lv_draw_rect.h
  - lv_draw_triangle.c
  - lv_draw_triangle.h
  - lv_draw_vector.c
  - lv_draw_vector.h
  - lv_draw_vector_private.h
  - lv_image_decoder.h
  - lv_image_dsc.h
- - Kconfig
  - lv_drivers.h
  - README.md
- - Kconfig
  - lv_font.c
  - lv_font.h
  - lv_font_dejavu_16_persian_hebrew.c
  - lv_font_montserrat_10.c
  - lv_font_montserrat_12.c
  - lv_font_montserrat_12_subpx.c
  - lv_font_montserrat_14.c
  - lv_font_montserrat_14_aligned.c
  - lv_font_montserrat_16.c
  - lv_font_montserrat_18.c
  - lv_font_montserrat_20.c
  - lv_font_montserrat_22.c
  - lv_font_montserrat_24.c
  - lv_font_montserrat_26.c
  - lv_font_montserrat_28.c
  - lv_font_montserrat_28_compressed.c
  - lv_font_montserrat_30.c
  - lv_font_montserrat_32.c
  - lv_font_montserrat_34.c
  - lv_font_montserrat_36.c
  - lv_font_montserrat_38.c
  - lv_font_montserrat_40.c
  - lv_font_montserrat_42.c
  - lv_font_montserrat_44.c
  - lv_font_montserrat_46.c
  - lv_font_montserrat_48.c
  - lv_font_montserrat_8.c
  - lv_font_private.h
  - lv_font_source_han_sans_sc_14_cjk.c
  - lv_font_source_han_sans_sc_16_cjk.c
  - lv_font_unscii_16.c
  - lv_font_unscii_8.c
  - lv_symbol_def.h
- - Kconfig
  - Kconfig.fs.template
  - lv_fs.c
  - lv_fs_arduino_esp_littlefs.cpp
  - lv_fs_arduino_sd.cpp
  - lv_fs_fatfs.c
  - lv_fs_frogfs.c
  - lv_fs_littlefs.c
  - lv_fs_memfs.c
  - lv_fs_posix.c
  - lv_fs_private.h
  - lv_fs_stdio.c
  - lv_fs_uefi.c
  - lv_fs_win32.c
- - Kconfig
  - lv_bin_decoder.c
  - lv_bmp.c
  - lv_image_decoder.c
  - lv_image_decoder_private.h
  - lv_libjpeg_turbo.c
  - lv_libpng.c
  - lv_libwebp.c
  - lv_lodepng.c
  - lv_tjpgd.c
- - Kconfig
  - lv_gridnav.c
  - lv_gridnav.h
  - lv_indev.c
  - lv_indev.h
  - lv_indev_gesture.c
  - lv_indev_gesture.h
  - lv_indev_gesture_private.h
  - lv_indev_private.h
  - lv_indev_scroll.c
  - lv_indev_scroll.h
- - Kconfig
.gitignore
.pre-commit-config.yaml
.typos.toml
CMakeLists.txt
CMakePresets.json
component.mk
COPYRIGHTS.md
gcovr.cfg
idf_component.yml
Kconfig
library.json
library.properties
LICENCE.txt
lv_conf_template.h
lv_version.h
lv_version.h.in
lvgl.h
lvgl.mk
lvgl_private.h
README.md
SConscript
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/lvgl/lvgl

Downloads the entire project code from GitHub to your computer.

cd lvgl

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f env_support/debian/Dockerfile -t lvgl .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 lvgl

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r sbom/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd env_support/qnx

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

lvgl

File Explorer

# Installation Guide

2. Docker

3. CMake

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

lvgl

File Explorer

# Installation Guide

2. Docker

3. CMake

4. Python

5. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README