[Dashboard] Disable layout changes when panel is expanded #152054

cqliu1 · 2023-02-24T00:43:43Z

Summary

Closes #152052.

This ignores dashboard layout changes when a panel is expanded to prevent accidental layout changes. This also cleans up some of the CSS for maximized panel to look more similar to a single panel on a dashboard and hides the resize handle in the bottom right corner.

One additional CSS change included in this PR is I switched the embeddable panel dashed border to a dashed outline to prevent panel resizing between view/edit mode.

Maximized Panel

Before	After

Disabled dragging when maximized

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2023-02-24T00:43:46Z

Pinging @elastic/kibana-presentation (Team:Presentation)

nreese

LGTM
code review

nreese · 2023-02-24T01:05:26Z

src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx

-      // onLayoutChange gets called by react grid layout a lot more than it should, so only dispatch the updated panels if the layout has actually changed
-      if (!getPanelLayoutsAreEqual(panels, updatedPanels)) {
-        dispatch(setPanels(updatedPanels));
+      if (!expandedPanelId) {


nit

Instead of nesting everything under if (!expandedPanelId), how about just returning early

if (expandedPanelId) { return; }

…rd/disable-layout-changes-in-maximize

…//github.com/cqliu1/kibana into dashboard/disable-layout-changes-in-maximize

cqliu1 · 2023-03-02T04:55:54Z

src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx

@@ -68,14 +68,13 @@ function ResponsiveGrid({
  });

  const MARGINS = useMargins ? 8 : 0;
-  // We can't take advantage of isDraggable or isResizable due to performance concerns:
-  // https://github.com/STRML/react-grid-layout/issues/240


This performance concern mentioned here is that react-grid-layout children were unmounted when isDraggable and isResizable were dynamically changed. This issue has since been resolved with this fix which went into RGL v0.81.0, and we're currently on v1.3.4.

…rd/disable-layout-changes-in-maximize

ThomThomson

Looked through the code and tested this locally. Everything works great!

As discussed offline, would love to see a performance comparison using the isResizable / isDraggable strategy vs pure CSS just for peace of mind.

ThomThomson · 2023-03-20T16:53:57Z

src/plugins/dashboard/public/dashboard_container/component/grid/_dashboard_grid.scss

@@ -33,6 +33,10 @@
 */
 .dshLayout-isMaximizedPanel {
  height: 100% !important; /* 1. */
+
+  .react-resizable-handle {
+    display: none; /* 1 */


nit: Is this still needed now that we have the isResizable set to false?

It looks like this isn't necessary anymore after setting isResizable to false. I'll remove this

ThomThomson · 2023-03-20T16:54:26Z

src/plugins/dashboard/public/dashboard_container/component/panel/_dashboard_panel.scss

@@ -21,4 +19,9 @@
  .embPanel {
    border-color: transparent;
  }
+
+  .embPanel--dragHandle:hover {


What is this new style for?

This one is to keep the title bar from setting that yellow background and prevent the cursor from changing to the move cursor to override styles defined by the embeddable plugin.

cqliu1 · 2023-03-20T20:10:39Z

I ran the performance profiler for loading a dashboard, switching from view mode to edit mode, and switching from edit mode to view mode. There are no significant differences in loading times afaict.

Loading dashboard

Main	This PR

View Mode -> Edit Mode

Main	This PR

Edit Mode -> View Mode

Main	This PR

ThomThomson · 2023-03-20T20:12:50Z

Amazing, thank you for doing those profiles! Definitely adds to my confidence in this PR.

andreadelrio

I think it'd be good to have an indicator for users to know that a panel is maximized (see screenshot below) but we can tackle that in a follow-up.

Nice job @cqliu1 !

kibana-ci · 2023-03-21T01:57:35Z

💚 Build Succeeded

Buildkite Build
Commit: 6df9027

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dashboard`	386.7KB	387.5KB	+880.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`embeddable`	75.3KB	75.3KB	+6.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`securitySolution`	433	436	+3

Total ESLint disabled count

id	before	after	diff
`securitySolution`	513	516	+3

History

💔 Build #114212 failed 52e28ae
💔 Build #114114 failed 8e8cb39
💔 Build #111599 failed ff100b7
💚 Build #111270 succeeded 6883347
💚 Build #111184 succeeded bf4f0f0

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

## Summary Closes #152052. This ignores dashboard layout changes when a panel is expanded to prevent accidental layout changes. This also cleans up some of the CSS for maximized panel to look more similar to a single panel on a dashboard and hides the resize handle in the bottom right corner. One additional CSS change included in this PR is I switched the embeddable panel dashed border to a dashed outline to prevent panel resizing between view/edit mode. ### Maximized Panel Before | After :------: | :------: ![Screenshot 2023-02-23 at 4 40 26 PM](https://user-images.githubusercontent.com/1697105/221063721-34a63f96-a7fe-4fab-a21d-c1108f4ba63d.png) | ![Screenshot 2023-02-23 at 4 39 55 PM](https://user-images.githubusercontent.com/1697105/221063765-a7da2c8e-8e60-469a-b607-872a8c3957aa.png) ### Disabled dragging when maximized ![Mar-20-2023 14-00-21](https://user-images.githubusercontent.com/1697105/226464826-1882fbcd-cfcb-471c-8e6c-e795d0c3762b.gif) ### Checklist Delete any items that are not applicable to this PR. - [ ] 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) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] 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)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### 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)

…2054) ## Summary Closes elastic#152052. This ignores dashboard layout changes when a panel is expanded to prevent accidental layout changes. This also cleans up some of the CSS for maximized panel to look more similar to a single panel on a dashboard and hides the resize handle in the bottom right corner. One additional CSS change included in this PR is I switched the embeddable panel dashed border to a dashed outline to prevent panel resizing between view/edit mode. ### Maximized Panel Before | After :------: | :------: ![Screenshot 2023-02-23 at 4 40 26 PM](https://user-images.githubusercontent.com/1697105/221063721-34a63f96-a7fe-4fab-a21d-c1108f4ba63d.png) | ![Screenshot 2023-02-23 at 4 39 55 PM](https://user-images.githubusercontent.com/1697105/221063765-a7da2c8e-8e60-469a-b607-872a8c3957aa.png) ### Disabled dragging when maximized ![Mar-20-2023 14-00-21](https://user-images.githubusercontent.com/1697105/226464826-1882fbcd-cfcb-471c-8e6c-e795d0c3762b.gif) ### Checklist Delete any items that are not applicable to this PR. - [ ] 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) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] 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)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### 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)

Disable layout changes when panel is expanded

dbbdc38

cqliu1 requested review from a team as code owners February 24, 2023 00:43

cqliu1 changed the title ~~Disable layout changes when panel is expanded~~ [Dashboard] Disable layout changes when panel is expanded Feb 24, 2023

nreese approved these changes Feb 24, 2023

View reviewed changes

nreese reviewed Feb 24, 2023

View reviewed changes

cqliu1 added 7 commits February 24, 2023 08:54

Add early return

d7eb690

Updated snapshots

105e1ff

Restore withoutMargins css

63d17a1

Merge branch 'main' of https://github.com/elastic/kibana into dashboa…

d077d9c

…rd/disable-layout-changes-in-maximize

Merge branch 'main' into dashboard/disable-layout-changes-in-maximize

bf4f0f0

Don't show title hover background and move cursor when maximized

0e2cf2b

Merge branch 'dashboard/disable-layout-changes-in-maximize' of https:…

6883347

…//github.com/cqliu1/kibana into dashboard/disable-layout-changes-in-maximize

MichaelMarcialis approved these changes Mar 1, 2023

View reviewed changes

andreadelrio self-requested a review March 1, 2023 19:50

Dynamically set isDraggable and isResizable in ReactGridLayout

ff100b7

cqliu1 commented Mar 2, 2023

View reviewed changes

Merge branch 'main' of https://github.com/elastic/kibana into dashboa…

8e8cb39

…rd/disable-layout-changes-in-maximize

ThomThomson approved these changes Mar 20, 2023

View reviewed changes

Removed unnecessary styles

9e04db2

Switch border to outline on embed panel

52e28ae

botelastic bot added the Feature:Embedding Embedding content via iFrame label Mar 20, 2023

andreadelrio approved these changes Mar 20, 2023

View reviewed changes

Fix functional test

6df9027

cqliu1 merged commit 16de10b into elastic:main Mar 21, 2023

cqliu1 deleted the dashboard/disable-layout-changes-in-maximize branch March 21, 2023 15:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard] Disable layout changes when panel is expanded #152054

[Dashboard] Disable layout changes when panel is expanded #152054

cqliu1 commented Feb 24, 2023 •

edited

elasticmachine commented Feb 24, 2023

nreese left a comment

nreese Feb 24, 2023

cqliu1 Mar 2, 2023 •

edited

ThomThomson left a comment

ThomThomson Mar 20, 2023

cqliu1 Mar 20, 2023

ThomThomson Mar 20, 2023

cqliu1 Mar 20, 2023

cqliu1 commented Mar 20, 2023 •

edited

ThomThomson commented Mar 20, 2023 •

edited

andreadelrio left a comment •

edited

kibana-ci commented Mar 21, 2023

ESLint disabled line counts

Total ESLint disabled count

[Dashboard] Disable layout changes when panel is expanded #152054

[Dashboard] Disable layout changes when panel is expanded #152054

Conversation

cqliu1 commented Feb 24, 2023 • edited

Summary

Maximized Panel

Disabled dragging when maximized

Checklist

Risk Matrix

For maintainers

elasticmachine commented Feb 24, 2023

nreese left a comment

Choose a reason for hiding this comment

nreese Feb 24, 2023

Choose a reason for hiding this comment

cqliu1 Mar 2, 2023 • edited

Choose a reason for hiding this comment

ThomThomson left a comment

Choose a reason for hiding this comment

ThomThomson Mar 20, 2023

Choose a reason for hiding this comment

cqliu1 Mar 20, 2023

Choose a reason for hiding this comment

ThomThomson Mar 20, 2023

Choose a reason for hiding this comment

cqliu1 Mar 20, 2023

Choose a reason for hiding this comment

cqliu1 commented Mar 20, 2023 • edited

Loading dashboard

View Mode -> Edit Mode

Edit Mode -> View Mode

ThomThomson commented Mar 20, 2023 • edited

andreadelrio left a comment • edited

Choose a reason for hiding this comment

kibana-ci commented Mar 21, 2023

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

cqliu1 commented Feb 24, 2023 •

edited

cqliu1 Mar 2, 2023 •

edited

cqliu1 commented Mar 20, 2023 •

edited

ThomThomson commented Mar 20, 2023 •

edited

andreadelrio left a comment •

edited