Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dashboard): Add description to the native filter #17025

Merged
merged 11 commits into from
Oct 27, 2021

Conversation

m-ajay
Copy link
Contributor

@m-ajay m-ajay commented Oct 7, 2021

SUMMARY

Add a description column to the native filter. Show the description on hover.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

tooltip

TESTING INSTRUCTIONS

  1. Turn native filters feature flags ON
  2. Open a dashbboard, and click edit native filters
  3. Add help text to the description column
  4. Save
  5. Hover over the "i" icon to see the description

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags: DASHBOARD_NATIVE_FILTERS, DASHBOARD_NATIVE_FILTERS_SET
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@graceguo-supercat
Copy link

@m-ajay and @rusackas Please add design comments.

@codecov
Copy link

codecov bot commented Oct 7, 2021

Codecov Report

Merging #17025 (7594453) into master (4316fe6) will increase coverage by 0.00%.
The diff coverage is 95.45%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #17025   +/-   ##
=======================================
  Coverage   76.96%   76.96%           
=======================================
  Files        1037     1037           
  Lines       55608    55625   +17     
  Branches     7588     7594    +6     
=======================================
+ Hits        42800    42814   +14     
- Misses      12558    12561    +3     
  Partials      250      250           
Flag Coverage Δ
javascript 71.02% <95.45%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
...nd/src/dashboard/components/nativeFilters/types.ts 100.00% <ø> (ø)
...Filters/FilterBar/FilterControls/FilterControl.tsx 94.87% <88.88%> (-5.13%) ⬇️
...onfigModal/FiltersConfigForm/FiltersConfigForm.tsx 69.32% <100.00%> (+0.07%) ⬆️
...mponents/nativeFilters/FiltersConfigModal/utils.ts 65.90% <100.00%> (+0.26%) ⬆️
...eFilters/FiltersConfigModal/FiltersConfigModal.tsx 87.13% <0.00%> (-0.59%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4316fe6...7594453. Read the comment docs.

@geido
Copy link
Member

geido commented Oct 8, 2021

/testenv up FEATURE_DASHBOARD_NATIVE_FILTERS=true FEATURE_DASHBOARD_CROSS_FILTERS=true FEATURE_DASHBOARD_NATIVE_FILTERS_SET=true FEATURE_DASHBOARD_FILTERS_EXPERIMENTAL=true

@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2021

@geido Ephemeral environment spinning up at http://54.218.236.238:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

@geido
Copy link
Member

geido commented Oct 8, 2021

@m-ajay Thanks for the functionality! I noticed a small issue. If you enter an empty char in the description, the tooltip will show up anyway

Screen Shot 2021-10-08 at 13 19 33

@michael-s-molina
Copy link
Member

We should handle long texts in the description:

Screen.Recording.2021-10-08.at.7.30.37.AM.mov

You can style the tooltip content with the following to fix it:

display: -webkit-box;
-webkit-line-clamp: 20;
-webkit-box-orient: vertical;
overflow: hidden;
text-overflow: ellipsis;

@michael-s-molina
Copy link
Member

The asterisk should come before the description icon for required filters.

Screen Shot 2021-10-14 at 8 54 35 AM

@michael-s-molina
Copy link
Member

/testenv up FEATURE_DASHBOARD_NATIVE_FILTERS=true FEATURE_DASHBOARD_CROSS_FILTERS=true FEATURE_DASHBOARD_NATIVE_FILTERS_SET=true FEATURE_DASHBOARD_FILTERS_EXPERIMENTAL=true

@github-actions
Copy link
Contributor

@michael-s-molina Ephemeral environment spinning up at http://34.222.229.189:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

@m-ajay Requested some changes, especially about the use of the theme variable.

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the contribution @m-ajay!

@etr2460
Copy link
Member

etr2460 commented Oct 27, 2021

yes, thanks for all the hard work and iteration!

@etr2460 etr2460 merged commit 65f1644 into apache:master Oct 27, 2021
@github-actions
Copy link
Contributor

Ephemeral environment shutdown and build artifacts deleted.

@m-ajay m-ajay deleted the feat/add-filter-description branch October 28, 2021 13:00
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.5.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/L 🚢 1.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants