[Dashboard] Add reset button #154872
Merged
[Dashboard] Add reset button #154872
Conversation
This file contains 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
Heenawter
added
release_note:enhancement
Feature:Dashboard
Heenawter
force-pushed
the
dashboard-reset-button_2023-04-12
branch
8 times, most recently
from
895d062
to
c24ceb5
Compare
Heenawter
force-pushed
the
dashboard-reset-button_2023-04-12
branch
2 times, most recently
from
e69b59d
to
3bbdf18
Compare
Heenawter
commented
Apr 17, 2023
| state.explicitInput = state.componentState.lastSavedInput; | ||
| state.explicitInput = { | ||
| ...state.componentState.lastSavedInput, | ||
| viewMode: state.explicitInput.viewMode, // keep current view mode when resetting |
There was a problem hiding this comment.
It is possible for a view view mode to be included in a dashboard's saved input - for example, in the sample dashboards, their imported state is in view mode which meant that hitting the "reset" would actually flip them from edit mode into view mode (since this is included as part of the last saved input). This line ensures that view mode is ignored when resetting to the last saved input.
Heenawter
commented
Apr 17, 2023
Comment on lines
+132
to
+135
| onClose: (overlayRef) => { | ||
| if (overlayTracker) overlayTracker.clearOverlays(); | ||
| overlayRef.close(); | ||
| }, |
There was a problem hiding this comment.
This fixes a small bug I discovered with the panel settings flyout where, if you closed the flyout by clicking outside of the flyout rather than via the "Close" buttons, hasOverlays remains true and so a bunch of items in the top nav bar stayed disabled.
Before
After
Heenawter
force-pushed
the
dashboard-reset-button_2023-04-12
branch
3 times, most recently
from
717d39c
to
48a1c40
Compare
Heenawter
force-pushed
the
dashboard-reset-button_2023-04-12
branch
from
1f33bb3
to
322378b
Compare
Heenawter
force-pushed
the
dashboard-reset-button_2023-04-12
branch
from
f4d62fe
to
9c6c5ac
Compare
|
Some minor edits to the 2 Reset modals. Listing page and Dashboard edit mode Title: Reset dashboard? Dashboard view mode Title: Reset dashboard? |
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]Async chunks
Page load bundle
Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: |
Heenawter
commented
Apr 20, 2023
| defaultMessage: `All unsaved changes will be lost.`, | ||
| }) | ||
| : i18n.translate('dashboard.resetChangesConfirmModal.resetChangesDescription', { | ||
| defaultMessage: `This dashboard will return to its last saved state. You might lose changes to filters and queries.`, |
There was a problem hiding this comment.
@cqliu1 Brought up a good point that this could be rephrased to be something like "This dashboard will return to its last saved state. You might lose changes to things like filters and queries." to make it less explicit - after all, you could lose changes to control selections (which kinda fall in to the "filters" bucket) or maps zoom/positioning, but it's hard to call out those things specifically without potentially causing confusion.
Not sure we want to hold up this PR on a small copy change, but throwing it out there 💃
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
|
I like the new copy changes, they are concise and better to understand. Great work 👏 |
ThomThomson
approved these changes
Apr 21, 2023
kibanamachine
added
v8.8.0
backport:skip
kpatticha
pushed a commit
to kpatticha/kibana
that referenced
this pull request
Apr 25, 2023
Closes elastic#132457 ## Summary This PR adds a reset button to the dashboard top navigation in both edit and view mode - when clicked, if the dashboard has unsaved changes, it will revert the dashboard to the last saved state: https://user-images.githubusercontent.com/8698078/232918433-97bac4b0-7472-49e9-9eb3-2cb7c9e6edf6.mov > **Note** > The above video contains some old copy for the modals. Please refer to "All copy changes" below to see the updated copy. Note that, by adding more buttons to the top nav bar, we are increasing the risk of someone hitting [this accessibility issue](elastic#154414) (where the breadcrumbs get completely overlapped before the browser is small enough for the navigation to collapse) - this will either be addressed on the Shared UX side or will be addressed as part of our [nav bar redesign](elastic#154945) 👍 ### All Copy Changes - **Listing Page** | Before | After | |--------|-------| |  |  | |  |  | - **Dashboard - _Edit Mode_** | Before | After | |--------|-------| |  |  | - **Dashboard - _View Mode_** | Before | After | |--------|-------| | N/A since you couldn't discard changes from view mode previously |  | ### Flaky Test Runner - `test/functional/apps/dashboard/group1/dashboard_unsaved_state.ts` <a href="https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2144"><img src="https://user-images.githubusercontent.com/8698078/232622312-8532bc7e-a699-45ee-862d-739d116c5dba.png"></a> - `test/functional/apps/dashboard_elements/controls/options_list/options_list_dashboard_interaction.ts` <a href="https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2143"><img src="https://user-images.githubusercontent.com/8698078/232615061-f01439e8-3a69-4190-8b6f-1926e1fa776a.png"></a> ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) (Refer above) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
nikitaindik
pushed a commit
to nikitaindik/kibana
that referenced
this pull request
Apr 25, 2023
Closes elastic#132457 ## Summary This PR adds a reset button to the dashboard top navigation in both edit and view mode - when clicked, if the dashboard has unsaved changes, it will revert the dashboard to the last saved state: https://user-images.githubusercontent.com/8698078/232918433-97bac4b0-7472-49e9-9eb3-2cb7c9e6edf6.mov > **Note** > The above video contains some old copy for the modals. Please refer to "All copy changes" below to see the updated copy. Note that, by adding more buttons to the top nav bar, we are increasing the risk of someone hitting [this accessibility issue](elastic#154414) (where the breadcrumbs get completely overlapped before the browser is small enough for the navigation to collapse) - this will either be addressed on the Shared UX side or will be addressed as part of our [nav bar redesign](elastic#154945) 👍 ### All Copy Changes - **Listing Page** | Before | After | |--------|-------| |  |  | |  |  | - **Dashboard - _Edit Mode_** | Before | After | |--------|-------| |  |  | - **Dashboard - _View Mode_** | Before | After | |--------|-------| | N/A since you couldn't discard changes from view mode previously |  | ### Flaky Test Runner - `test/functional/apps/dashboard/group1/dashboard_unsaved_state.ts` <a href="https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2144"><img src="https://user-images.githubusercontent.com/8698078/232622312-8532bc7e-a699-45ee-862d-739d116c5dba.png"></a> - `test/functional/apps/dashboard_elements/controls/options_list/options_list_dashboard_interaction.ts` <a href="https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2143"><img src="https://user-images.githubusercontent.com/8698078/232615061-f01439e8-3a69-4190-8b6f-1926e1fa776a.png"></a> ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) (Refer above) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
19 tasks
KOTungseth
added a commit
that referenced
this pull request
May 16, 2023
## Summary Adds the docs for the following 8.8 Presentation docs: - Unified dashboard settings: #153862 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings - Add reset button: #154872 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard --------- Co-authored-by: Nick Peihl <nickpeihl@gmail.com> Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
May 16, 2023
## Summary Adds the docs for the following 8.8 Presentation docs: - Unified dashboard settings: elastic#153862 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings - Add reset button: elastic#154872 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard --------- Co-authored-by: Nick Peihl <nickpeihl@gmail.com> Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com> (cherry picked from commit 0689c63)
kibanamachine
referenced
this pull request
May 16, 2023
# Backport This will backport the following commits from `main` to `8.8`: - [[DOCS] Adds the presentation 8.8 docs (#157765)](#157765) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Kaarina Tungseth","email":"kaarina.tungseth@elastic.co"},"sourceCommit":{"committedDate":"2023-05-16T19:21:01Z","message":"[DOCS] Adds the presentation 8.8 docs (#157765)\n\n## Summary\r\n\r\nAdds the docs for the following 8.8 Presentation docs:\r\n\r\n- Unified dashboard settings:\r\nhttps://github.com//pull/153862\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings\r\n\r\n- Add reset button: https://github.com/elastic/kibana/pull/154872\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard\r\n\r\n---------\r\n\r\nCo-authored-by: Nick Peihl <nickpeihl@gmail.com>\r\nCo-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>","sha":"0689c638d3b3e4c8a9d00e1c2da2412a257771ce","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Presentation","release_note:skip","v8.8.0","v8.9.0"],"number":157765,"url":"https://github.com/elastic/kibana/pull/157765","mergeCommit":{"message":"[DOCS] Adds the presentation 8.8 docs (#157765)\n\n## Summary\r\n\r\nAdds the docs for the following 8.8 Presentation docs:\r\n\r\n- Unified dashboard settings:\r\nhttps://github.com//pull/153862\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings\r\n\r\n- Add reset button: https://github.com/elastic/kibana/pull/154872\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard\r\n\r\n---------\r\n\r\nCo-authored-by: Nick Peihl <nickpeihl@gmail.com>\r\nCo-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>","sha":"0689c638d3b3e4c8a9d00e1c2da2412a257771ce"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157765","number":157765,"mergeCommit":{"message":"[DOCS] Adds the presentation 8.8 docs (#157765)\n\n## Summary\r\n\r\nAdds the docs for the following 8.8 Presentation docs:\r\n\r\n- Unified dashboard settings:\r\nhttps://github.com//pull/153862\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings\r\n\r\n- Add reset button: https://github.com/elastic/kibana/pull/154872\r\nDocs preview:\r\nhttps://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard\r\n\r\n---------\r\n\r\nCo-authored-by: Nick Peihl <nickpeihl@gmail.com>\r\nCo-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>","sha":"0689c638d3b3e4c8a9d00e1c2da2412a257771ce"}}]}] BACKPORT--> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
jasonrhodes
pushed a commit
that referenced
this pull request
May 17, 2023
![https://user-images.githubusercontent.com/8698078/232622312-8532bc7e-a699-45ee-862d-739d116c5dba.png"></a](https://user-images.githubusercontent.com/8698078/232622312-8532bc7e-a699-45ee-862d-739d116c5dba.png"></a){kind=link}
![https://user-images.githubusercontent.com/8698078/232615061-f01439e8-3a69-4190-8b6f-1926e1fa776a.png"></a](https://user-images.githubusercontent.com/8698078/232615061-f01439e8-3a69-4190-8b6f-1926e1fa776a.png"></a){kind=link}
## Summary Adds the docs for the following 8.8 Presentation docs: - Unified dashboard settings: #153862 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#add-dashboard-settings - Add reset button: #154872 Docs preview: https://kibana_157765.docs-preview.app.elstc.co/guide/en/kibana/master/dashboard.html#reset-the-dashboard --------- Co-authored-by: Nick Peihl <nickpeihl@gmail.com> Co-authored-by: Hannah Mudge <Heenawter@users.noreply.github.com>
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.
Closes #132457
Summary
This PR adds a reset button to the dashboard top navigation in both edit and view mode - when clicked, if the dashboard has unsaved changes, it will revert the dashboard to the last saved state:
Screen.Recording.2023-04-18.at.4.24.27.PM.mov
Note that, by adding more buttons to the top nav bar, we are increasing the risk of someone hitting this accessibility issue (where the breadcrumbs get completely overlapped before the browser is small enough for the navigation to collapse) - this will either be addressed on the Shared UX side or will be addressed as part of our nav bar redesign 👍
All Copy Changes
Listing Page
Dashboard - Edit Mode
Dashboard - View Mode
Flaky Test Runner
test/functional/apps/dashboard/group1/dashboard_unsaved_state.tstest/functional/apps/dashboard_elements/controls/options_list/options_list_dashboard_interaction.tsChecklist
For maintainers