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

fix(core/tooltip): remove arrow if not visible #451

Merged
merged 4 commits into from
Mar 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/core/src/components/tooltip/tooltip.scss
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
:host {
display: inline-block;
position: absolute;
position: fixed;
left: 0px;
top: 0px;
z-index: var(--theme-z-index-tooltip);

max-width: 18.25rem;

opacity: 0;
visibility: collapse;
visibility: collapse !important;
overflow-wrap: break-word;

border-radius: 0.25rem;
Expand All @@ -28,10 +29,10 @@

:host(.visible) {
opacity: 1;
visibility: visible;
visibility: visible !important;
}

:host {
:host(.visible) {
.arrow,
.arrow::before {
position: absolute;
Expand Down
69 changes: 37 additions & 32 deletions packages/core/src/components/tooltip/tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
*/
import {
arrow,
autoPlacement,
autoUpdate,
computePosition,
flip,
offset,
shift,
} from '@floating-ui/dom';
Expand Down Expand Up @@ -59,7 +59,7 @@ export class Tooltip {
}

private destroyAutoUpdate() {
if (this.disposeAutoUpdate) {
if (this.disposeAutoUpdate !== undefined) {
this.disposeAutoUpdate();
}
}
Expand All @@ -82,39 +82,44 @@ export class Tooltip {
target,
this.hostElement,
async () => {
const computeResponse = await computePosition(
target,
this.hostElement,
{
strategy: 'absolute',
placement: 'top',
middleware: [
shift(),
offset(8),
arrow({
element: this.arrowElement,
}),
autoPlacement({
alignment: 'start',
allowedPlacements: ['top', 'bottom', 'right', 'left'],
}),
],
requestAnimationFrame(async () => {
const computeResponse = await computePosition(
target,
this.hostElement,
{
strategy: 'fixed',
placement: 'top',
middleware: [
shift(),
offset(8),
arrow({
element: this.arrowElement,
}),
flip({
fallbackStrategy: 'initialPlacement',
}),
],
}
);

if (computeResponse.middlewareData.arrow) {
let { x, y } = computeResponse.middlewareData.arrow;

if (computeResponse.placement === 'bottom') {
y = -4;
}

Object.assign(this.arrowElement.style, {
left: x != null ? `${x}px` : '',
top: y != null ? `${y}px` : '',
});
}
);

if (computeResponse.middlewareData.arrow) {
const { x, y } = computeResponse.middlewareData.arrow;

Object.assign(this.arrowElement.style, {
left: x != null ? `${x}px` : '',
top: y != null ? `${y}px` : '',
const { x, y } = computeResponse;
Object.assign(this.hostElement.style, {
left: x !== null ? `${x}px` : '',
top: y !== null ? `${y}px` : '',
});
}

const { x, y } = computeResponse;
Object.assign(this.hostElement.style, {
left: x !== null ? `${x}px` : '',
top: y !== null ? `${y}px` : '',
});
},
{
Expand Down
37 changes: 37 additions & 0 deletions packages/core/src/tests/tooltip/placement-fallback/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!--
SPDX-FileCopyrightText: 2023 Siemens AG

SPDX-License-Identifier: MIT
-->

<html>
<head>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=5.0"
/>
<title>Stencil Component Starter</title>
</head>
<body>
<ix-button data-tooltip="Test1">Long text</ix-button>
<ix-button data-tooltip="Test2">Short</ix-button>
<ix-button data-tooltip="Test3">Long text short words</ix-button>

<ix-tooltip for='[data-tooltip="Test1"]' title-content="Title content">
Very very very very very very looooooooooooooooooooooooooooooooooooooooong
text
</ix-tooltip>
<ix-tooltip for='[data-tooltip="Test2"]' title-content="Title content">
<ix-icon slot="title-icon" name="rocket"></ix-icon>
Short
</ix-tooltip>
<ix-tooltip for='[data-tooltip="Test3"]'>
<ix-icon slot="title-icon" name="rocket"></ix-icon>
<span slot="title-content">Slot based content</span>
Very very very very very very long long long text
</ix-tooltip>

<script src="http://127.0.0.1:8080/scripts/e2e/load-e2e-runtime.js"></script>
</body>
</html>
21 changes: 18 additions & 3 deletions packages/core/src/tests/tooltip/tooltip.e2e.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ regressionTest.describe('tooltip', () => {
await page.waitForTimeout(500);

expect(await page.screenshot({ fullPage: true })).toMatchSnapshot({
maxDiffPixelRatio: 0.02,
maxDiffPixelRatio: 0.01,
});
});

Expand All @@ -37,7 +37,7 @@ regressionTest.describe('tooltip', () => {
await page.waitForTimeout(500);

expect(await page.screenshot({ fullPage: true })).toMatchSnapshot({
maxDiffPixelRatio: 0.02,
maxDiffPixelRatio: 0.01,
});
});

Expand All @@ -52,7 +52,22 @@ regressionTest.describe('tooltip', () => {
await page.waitForTimeout(500);

expect(await page.screenshot({ fullPage: true })).toMatchSnapshot({
maxDiffPixelRatio: 0.02,
maxDiffPixelRatio: 0.01,
});
});

regressionTest('fallback placement', async ({ page }) => {
await page.goto('tooltip/placement-fallback');

const tooltipTriggerHandler = await page.waitForSelector(
'[data-tooltip="Test3"]'
);

await tooltipTriggerHandler.hover();
await page.waitForTimeout(500);

expect(await page.screenshot({ fullPage: true })).toMatchSnapshot({
maxDiffPixelRatio: 0.01,
});
});
});
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.