LVGL Pro

What is LVGL Pro?

LVGL Pro is the visual UI editor for LVGL-based firmware projects in which you can build UIs in XML, preview them in real time in a pixel-perfect preview, load the XMLs at runtime, or export clean C code for compile-time integration.

Its output is in the form of XML files that you create (with the help of LVGL Pro's smart editor) and/or finished C code, either or both of which can be reused in any number of LVGL firmware projects.

Contents:

• Overview
  • Reasons to Use LVGL Pro
  • User Interface
• Files
  • XML File Format
  • Projects vs Component Libraries
• Quick Start
  • Getting LVGL Pro
  • Installing
  • First Run
  • Tutorial Project
• Integrating an Editor Project into Firmware
  • Prerequisites
  • Using Exported C Code
  • Using XML Files
  • Combining C and XML
  • VSCode Simulator
  • ESP-IDF
• Project Setup
  • globals.xml File
  • project.xml File
• Creating UI Elements
  • Creating Components
  • Creating Screens
  • Creating Widgets
• UI Element Features
  • Styles and Properties
  • Constants
  • Fonts
  • Animations
  • Translations
  • Tests
  • Binding to Data
• Extending Your UI with Custom Code
  • Adding Event Callbacks
  • Adding Custom C Code to an Instance of a Component
  • Modify Values with Custom C Logic
  • Flexibility of Customizations
• Keyboard Shortcuts
  • Activate Auto-Completion
  • Value Modification
  • Preview Pane
• Online Preview
• Figma Plugin
• Command-Line Interface
• Troubleshooting
  • Launching on Linux
• XML Tag Reference
  • Comments
• Glossary
• Credits

TODO List

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/animations.rst, line 9.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/binding_to_data.rst, line 9.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/extending_with_custom_code.rst, line 28.)

Todo

verify or correct above syntax for attrs argument. This should be well documented in the function's documentation as well.

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/integrating_into_firmware.rst, line 84.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/integrating_into_firmware.rst, line 92.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/keyboard_shortcuts.rst, line 41.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/online_preview.rst, line 9.)

Todo

confirm or adjust the above

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/styles_and_properties.rst, line 39.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/tests.rst, line 9.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/translations.rst, line 9.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/widgets.rst, line 37.)

Todo

fill in

(The original entry is located in /home/runner/work/editor_docs/editor_docs/docs/src/xml_tag_reference.rst, line 22.)