superset icon indicating copy to clipboard operation
superset copied to clipboard

feat(dashboard): Edit dashboard description from ui (and api) and show tooltip on dashboard list view

Open greggailly opened this issue 1 month ago β€’ 10 comments

User description

feat(dashboard): Edit dashboard description from ui (and api) and show tooltip on dashboard list view

SUMMARY

Similar to the description field on charts, this PR adds a text area field in the dashboard properties modal to update the description. Works from the list and from the dashboard header edit mode as well.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before

Edit modal Screenshot 2025-11-11 at 11 00 52

List view Screenshot 2025-11-11 at 11 00 46

After

Edit modal Screenshot 2025-11-11 at 10 52 56

List view with tooltip Screenshot 2025-11-11 at 10 53 03

ADDITIONAL INFORMATION

  • [x] Has associated issue: Fixes #27410
  • [x] Changes UI
  • [x] Introduces new feature or API

CodeAnt-AI Description

Add editable dashboard description and show it as tooltip in list

What Changed

  • A Description field is added to the dashboard properties modal and header edit flow so users can add or update a dashboard description when saving.
  • Dashboard list view shows an info tooltip next to a dashboard title when a description exists, letting users read the description on hover.
  • The backend API and listing now include the description field so descriptions are persisted and returned; integration tests and frontend save/list logic were updated accordingly.

Impact

βœ… Edit and save dashboard descriptions βœ… See dashboard descriptions from list via hover tooltip βœ… API returns dashboard descriptions for list and detail

πŸ’‘ Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

greggailly avatar Nov 11 '25 10:11 greggailly

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 67.99%. Comparing base (1127374) to head (368d422). :warning: Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #36071       +/-   ##
===========================================
+ Coverage        0   67.99%   +67.99%     
===========================================
  Files           0      635      +635     
  Lines           0    46831    +46831     
  Branches        0     5082     +5082     
===========================================
+ Hits            0    31844    +31844     
- Misses          0    13717    +13717     
- Partials        0     1270     +1270     
Flag Coverage Ξ”
hive 43.71% <100.00%> (?)
mysql 67.05% <100.00%> (?)
postgres 67.10% <100.00%> (?)
presto 47.37% <100.00%> (?)
python 67.96% <100.00%> (?)
sqlite 66.81% <100.00%> (?)
unit 100.00% <ΓΈ> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Nov 12 '25 15:11 codecov[bot]

Superset uses Git pre-commit hooks courtesy of pre-commit. To install run the following:

pip3 install -r requirements/development.txt
pre-commit install

A series of checks will now run when you make a git commit.

Alternatively it is possible to run pre-commit by running pre-commit manually:

pre-commit run --all-files

rusackas avatar Nov 12 '25 18:11 rusackas

Superset uses Git pre-commit hooks courtesy of pre-commit. To install run the following:

pip3 install -r requirements/development.txt
pre-commit install

A series of checks will now run when you make a git commit.

Alternatively it is possible to run pre-commit by running pre-commit manually:

pre-commit run --all-files

sadpandajoe avatar Nov 13 '25 22:11 sadpandajoe

@sadpandajoe done thanks for the heads up ! I still get two errors when running with --all-files but they seem to be coming from other recently merged commits. Rebased on master on the same occasion.

greggailly avatar Nov 14 '25 08:11 greggailly

@sadpandajoe @rusackas the two failing tests in tests/integration_tests/dashboards/api_tests.py have been fixed.

greggailly avatar Nov 27 '25 08:11 greggailly

LGTM other than a duplicate field being added here. I think you can just delete that?

rusackas avatar Dec 06 '25 00:12 rusackas

CodeAnt AI is reviewing your PR.

LGTM other than a duplicate field being added here. I think you can just delete that?

Done ! Thanks πŸ‘

greggailly avatar Dec 06 '25 14:12 greggailly

CodeAnt AI finished reviewing your PR.

Replied to the two threads... I think the CSS one does need a tweak (with a little scope creep into the existing file you copied from) where the other seems like a "good idea" though not really necessary, per se.

rusackas avatar Dec 08 '25 17:12 rusackas

CodeAnt AI is running Incremental review

Replied to the two threads... I think the CSS one does need a tweak (with a little scope creep into the existing file you copied from) where the other seems like a "good idea" though not really necessary, per se.

@rusackas Pushed the two small changes !

greggailly avatar Dec 12 '25 14:12 greggailly