Skip to content

frontend: add tooltip for yellow parameters in ParameterLoader#3736

Merged
patrickelectric merged 2 commits intobluerobotics:masterfrom
nicoschmdt:explain-parameters
Jan 23, 2026
Merged

frontend: add tooltip for yellow parameters in ParameterLoader#3736
patrickelectric merged 2 commits intobluerobotics:masterfrom
nicoschmdt:explain-parameters

Conversation

@nicoschmdt
Copy link
Contributor

@nicoschmdt nicoschmdt commented Jan 23, 2026

fix #3546

image

Also fixed the ParameterLoader dialog which was opening twice everytime.

Summary by Sourcery

Add an informational tooltip to the ParameterLoader dialog and adjust its placement to prevent it from opening twice.

New Features:

  • Display a tooltip in the ParameterLoader dialog explaining the meaning of yellow parameters.

Bug Fixes:

  • Ensure the ParameterLoader dialog is only instantiated once to avoid it opening twice.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 23, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds an explanatory tooltip to the ParameterLoader dialog title for yellow-highlighted parameters and fixes the dialog being instantiated twice by moving its single instance outside of card bodies in ParamSets.vue.

Sequence diagram for single ParameterLoader instance in ParamSets

sequenceDiagram
  actor User
  participant ParamSets as ParamSets_vue
  participant ParameterLoader as ParameterLoader_vue

  User->>ParamSets: select_paramset_and_click_load
  ParamSets->>ParamSets: set selected_paramset
  ParamSets->>ParameterLoader: pass_parameters(selected_paramset)
  activate ParameterLoader
  ParameterLoader->>User: show_dialog_with_tooltip

  User->>ParameterLoader: confirm_or_cancel
  ParameterLoader-->>ParamSets: done
  deactivate ParameterLoader
  ParamSets->>ParamSets: selected_paramset = {}
  ParamSets-->>User: dialog_closed
Loading

File-Level Changes

Change Details Files
Ensure ParameterLoader dialog is only rendered once instead of twice in the ParamSets overview.
  • Removed duplicated in-card ParameterLoader instances that were conditionally rendered inside the two v-card sections.
  • Added a single shared ParameterLoader component instance after the cards, still controlled by the selected_paramset v-if and done handler to reset selection.
core/frontend/src/components/vehiclesetup/overview/ParamSets.vue
Add a tooltip explaining the meaning of yellow parameters in the ParameterLoader dialog header.
  • Extended the v-card-title in ParameterLoader to include a Vuetify v-tooltip wrapping a warning-colored information icon.
  • Tooltip content clarifies that yellow parameters are unavailable on the current vehicle, possibly due to firmware version differences or related _ENABLE parameters being disabled.
core/frontend/src/components/parameter-editor/ParameterLoader.vue

Assessment against linked issues

Issue Objective Addressed Explanation
#3546 Update the ParameterLoader UI to explain what yellow parameters represent and how users should interpret/deal with them (i.e., that they are parameters not available on the vehicle because they may not exist in the firmware or may be disabled by an _ENABLE parameter).

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue, and left some high level feedback:

  • In ParamSets.vue, selected_paramset is set to {} on @done while the dialog is shown with v-if="selected_paramset", so the loader may never close because an empty object is still truthy; consider using null or a more explicit condition instead.
  • For the new info icon tooltip in ParameterLoader.vue, consider adding an accessible label/aria attributes or making the icon button-like to ensure screen readers and keyboard users can discover and focus it.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `ParamSets.vue`, `selected_paramset` is set to `{}` on `@done` while the dialog is shown with `v-if="selected_paramset"`, so the loader may never close because an empty object is still truthy; consider using `null` or a more explicit condition instead.
- For the new info icon tooltip in `ParameterLoader.vue`, consider adding an accessible label/aria attributes or making the icon button-like to ensure screen readers and keyboard users can discover and focus it.

## Individual Comments

### Comment 1
<location> `core/frontend/src/components/parameter-editor/ParameterLoader.vue:11-12` </location>
<code_context>
       <v-card-title class="pt-6">
-        Loading Parameters
+        Loading Parameters 
+        <v-tooltip bottom>
+          <template #activator="{ on }">
+            <v-icon small color="warning" v-on="on">mdi-information-variant-box</v-icon>
+          </template>
</code_context>

<issue_to_address>
**issue (bug_risk):** Forwarding only `on` in the tooltip activator may drop important attributes and affect accessibility.

Vuetify’s tooltip activator slot usually provides both `on` and `attrs`, with the pattern `v-slot:activator="{ on, attrs }"` plus `v-on="on"` and `v-bind="attrs"` on the activator element. Using only `on` can drop ARIA/keyboard attributes and break expected behavior; please include `attrs` as well.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@patrickelectric patrickelectric merged commit 7085206 into bluerobotics:master Jan 23, 2026
7 checks passed
@nicoschmdt nicoschmdt deleted the explain-parameters branch February 12, 2026 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ParameterLoader should tell users what are the "Yellow" parameters and how to deal with them.

2 participants

Comments