feat(dashboard): Edit dashboard description from ui (and api) and show tooltip on dashboard list view #36071
Conversation
dosubot
bot
added
change:frontend
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
I've completed my review and didn't find any issues.
Files scanned
| File Path | Reviewed |
|---|---|
| superset-frontend/src/dashboard/components/PropertiesModal/sections/BasicInfoSection.tsx | ✅ |
| superset/dashboards/schemas.py | ✅ |
| superset-frontend/src/dashboard/components/PropertiesModal/index.tsx | ✅ |
| superset-frontend/src/pages/DashboardList/index.tsx | ✅ |
| superset-frontend/src/dashboard/components/Header/index.jsx | ✅ |
| superset-frontend/src/dashboard/actions/dashboardState.js | ✅ |
| superset/dashboards/api.py | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Check out our docs on how you can make Korbit work best for you and your team.
![bito-code-review[bot]](https://avatars.githubusercontent.com/in/1061978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review Agent Run #728dbc
Actionable Suggestions - 2
-
superset/dashboards/schemas.py - 1
- Inconsistent description length validation · Line 400-404
-
superset-frontend/src/dashboard/components/Header/index.jsx - 1
- Missing useCallback dependency for dashboard description · Line 425-425
Review Details
-
Files reviewed - 9 · Commit Range:
ff3abe1..c2e0262- superset-frontend/src/dashboard/actions/dashboardState.js
- superset-frontend/src/dashboard/components/Header/index.jsx
- superset-frontend/src/dashboard/components/PropertiesModal/index.tsx
- superset-frontend/src/dashboard/components/PropertiesModal/sections/BasicInfoSection.test.tsx
- superset-frontend/src/dashboard/components/PropertiesModal/sections/BasicInfoSection.tsx
- superset-frontend/src/pages/DashboardList/DashboardList.test.jsx
- superset-frontend/src/pages/DashboardList/index.tsx
- superset/dashboards/api.py
- superset/dashboards/schemas.py
-
Files skipped - 0
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at [email protected].
Documentation & Help
AI Code Review powered by
greggailly
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #36071 +/- ##
===========================================
+ Coverage 0 48.22% +48.22%
===========================================
Files 0 631 +631
Lines 0 45991 +45991
Branches 0 4987 +4987
===========================================
+ Hits 0 22177 +22177
- Misses 0 23188 +23188
- Partials 0 626 +626
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Superset uses Git pre-commit hooks courtesy of pre-commit. To install run the following: 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: |
There was a problem hiding this comment.
Pull Request Overview
This PR adds the ability to edit dashboard descriptions through the UI and API, including displaying the description as a tooltip in the dashboard list view.
Key Changes
- Backend API extended to support description field in GET and PUT endpoints
- Dashboard properties modal enhanced with a description text area field
- Dashboard list view updated to display descriptions as tooltips using InfoTooltip component
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| superset/dashboards/schemas.py | Added description field to DashboardGetResponseSchema and DashboardPutSchema with appropriate metadata |
| superset/dashboards/api.py | Added description to the list of columns in various endpoint configurations (show_columns, add_columns, edit_columns) |
| superset-frontend/src/pages/DashboardList/index.tsx | Added description to fetched columns, created FlexRowContainer styled component, and integrated InfoTooltip to display descriptions in the list view |
| superset-frontend/src/pages/DashboardList/DashboardList.test.jsx | Updated test snapshot to include description in the expected API call |
| superset-frontend/src/dashboard/components/PropertiesModal/sections/BasicInfoSection.tsx | Added description text area field to the basic info section of the properties modal |
| superset-frontend/src/dashboard/components/PropertiesModal/sections/BasicInfoSection.test.tsx | Updated test to verify description field is rendered |
| superset-frontend/src/dashboard/components/PropertiesModal/index.tsx | Integrated description field into form handling, extraction from API response, and submission logic |
| superset-frontend/src/dashboard/components/Header/index.jsx | Added description to dashboard save data and dependency array |
| superset-frontend/src/dashboard/actions/dashboardState.js | Added description field handling in save request logic |
|
Superset uses Git pre-commit hooks courtesy of pre-commit. To install run the following: 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: |
…m dashboard header
Co-authored-by: bito-code-review[bot] <188872107+bito-code-review[bot]@users.noreply.github.com>
greggailly
force-pushed
the
feature/dashboard_description
branch
from
af76139 to
610730d
Compare
|
@sadpandajoe done thanks for the heads up ! |
3 participants
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
List view
After
Edit modal
List view with tooltip
ADDITIONAL INFORMATION