Skip to content

Commit

Permalink
[Dashboard Usability] Remove borders from presentation panel and CSS …
Browse files Browse the repository at this point in the history
…clean up for hover actions (#198454)

## Summary

Closes #198370.
Follow up to #182535.

This removes border style overrides from the apps that support
embeddables and cleans up outline styles for presentation panel
borders/hover actions. I removed all of the dashboard specific border
styles and made them more generic for any embeddable panel. Now, the
borders respect the `showBorder` prop on the embeddable input. However
even when `showBorder` is `false`, a border is shown on focus/hover to
align with the border styles of the hover actions.

### 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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] 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#_add_your_labels)
- [ ] This will appear in the **Release Notes** and follow the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 9af4bb5)
  • Loading branch information
cqliu1 committed Nov 13, 2024
1 parent cdb923b commit 4dc93ee
Show file tree
Hide file tree
Showing 12 changed files with 165 additions and 243 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,12 @@
z-index: $euiZLevel9;
top: -$euiSizeXL;

// Show hover actions with drag handle
.embPanel__hoverActions:has(.embPanel--dragHandle) {
opacity: 1;
}

// Hide hover actions without drag handle
.embPanel__hoverActions:not(:has(.embPanel--dragHandle)) {
opacity: 0;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,44 +1,11 @@
/**
* EDITING MODE
* Use .dshLayout--editing to target editing state because
* .embPanel--editing doesn't get updating without a hard refresh
*/

.dshLayout--editing {
// change the style of the hover actions border to a dashed line in edit mode
.embPanel__hoverActionsAnchor {
.embPanel__hoverActionsWrapper {
.embPanel__hoverActions {
border-color: $euiColorMediumShade;
border-style: dashed;
}
}
}
}

// LAYOUT MODES
// Adjust borders/etc... for non-spaced out and expanded panels
.dshLayout-withoutMargins {
.embPanel,
.embPanel__hoverActionsAnchor {
box-shadow: none;
outline: none;
border-radius: 0;
}

&.dshLayout--editing {
.embPanel__hoverActionsAnchor:hover {
outline: 1px dashed $euiColorMediumShade;
}
}

.embPanel__hoverActionsAnchor:hover {
outline: $euiBorderThin;
z-index: $euiZLevel2;
}
margin-top: $euiSizeS;

.embPanel__content,
.dshDashboardGrid__item--highlighted,
.embPanel,
.embPanel__hoverActionsAnchor,
.lnsExpressionRenderer {
border-radius: 0;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Default.args = {
hideHeader: false,
loading: false,
showShadow: false,
showBorder: true,
showBorder: false,
title: 'Hello World',
viewMode: true,
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ export const getLensAttributes = (group: EventAnnotationGroupConfig, timeField:
language: 'kuery',
},
filters: [],
showBorder: false,
datasourceStates: {
formBased: {
layers: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
height: 100%;
min-height: $euiSizeL + 2px; // + 2px to account for border
position: relative;
border: none;
outline: $euiBorderThin;

&-isLoading {
// completely center the loading indicator
Expand Down Expand Up @@ -105,47 +103,9 @@
}
}

// OPTIONS MENU

/**
* 1. Use opacity to make this element accessible to screen readers and keyboard.
* 2. Show on focus to enable keyboard accessibility.
* 3. Always show in editing mode
*/

.embPanel__optionsMenuButton {
background-color: transparentize($euiColorLightShade, .5);
border-bottom-right-radius: 0;
border-top-left-radius: 0;

&:focus {
background-color: transparentize($euiColorLightestShade, .5);
}
}

.embPanel__optionsMenuPopover-loading {
width: $euiSizeS * 32;
}

.embPanel__optionsMenuPopover-notification::after {
position: absolute;
top: 0;
right: 0;
content: '';
transform: translate(50%, -50%);
color: $euiColorAccent;
font-size: $euiSizeL;
}

// EDITING MODE

.embPanel--editing {
transition: all $euiAnimSpeedFast $euiAnimSlightResistance;
outline: 1px dashed $euiColorMediumShade;

.embPanel--dragHandle {
transition: background-color $euiAnimSpeedFast $euiAnimSlightResistance;

.embPanel--dragHandle:hover {
background-color: transparentize($euiColorWarning, lightOrDarkTheme(.9, .7));
cursor: move;
Expand All @@ -170,56 +130,14 @@
z-index: $euiZLevel1;
}

.embPanel__hoverActionsAnchor {
position: relative;
height: 100%;

.embPanel__hoverActionsWrapper {
height: $euiSizeXL;
position: absolute;
top: 0;
display: flex;
justify-content: space-between;
padding: 0 $euiSize;
flex-wrap: nowrap;
min-width: 100%;
z-index: -1;
pointer-events: none; // Prevent hover actions wrapper from blocking interactions with other panels
}

.embPanel__hoverActions {
opacity: 0;
padding: calc($euiSizeXS - 1px);
display: flex;
flex-wrap: nowrap;
border: $euiBorderThin;

background-color: $euiColorEmptyShade;
height: $euiSizeXL;

pointer-events: all; // Re-enable pointer-events for hover actions
}

.embPanel--dragHandle {
cursor: move;
.embPanel--dragHandle {
cursor: move;

img {
pointer-events: all !important;
}
img {
pointer-events: all !important;
}
}

.embPanel__descriptionTooltipAnchor {
padding: $euiSizeXS;
}

&:hover .embPanel__hoverActionsWrapper,
&:focus-within .embPanel__hoverActionsWrapper,
.embPanel__hoverActionsWrapper--lockHoverActions {
z-index: $euiZLevel9;
top: -$euiSizeXL;

.embPanel__hoverActions {
opacity: 1;
}
}
}
.embPanel__descriptionTooltipAnchor {
padding: $euiSizeXS;
}
Loading

0 comments on commit 4dc93ee

Please sign in to comment.