[lvgl] Document animations and start/stop actions#6735
Open
clydebarrow wants to merge 1 commit into
Open
Conversation
Add components/lvgl/animation.mdx documenting the animations feature (config, animatable properties, timing functions, lambda values) and the lvgl.animation.start / lvgl.animation.stop actions. Link from the LVGL index. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for LVGL animations (configuration + timing functions + animatable properties) and links it from the LVGL docs index so users can discover and use lvgl.animation.start / lvgl.animation.stop.
Changes:
- Added a new
LVGL Animationsdocumentation page describing animation configuration, animatable properties, lambdas, and timing functions. - Documented
lvgl.animation.startandlvgl.animation.stopactions (with examples). - Linked animations into the main LVGL index (config option + actions pointer + See Also link).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/content/docs/components/lvgl/index.mdx | Adds references/links so animations are discoverable from the main LVGL documentation. |
| src/content/docs/components/lvgl/animation.mdx | New documentation page covering animation configuration details and related actions. |
19 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add components/lvgl/animation.mdx documenting the animations feature
(config, animatable properties, timing functions, lambda values) and the
lvgl.animation.start / lvgl.animation.stop actions. Link from the LVGL
index.
Description
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/public/images/folder of this repository.Use the image in your component's index table entry in
/src/content/docs/components/index.mdx.Example: For a component called "DHT22 Temperature Sensor", use:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.