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(Tooltip, Popover): allow styling target wrapper #1262

Merged
merged 1 commit into from
Oct 8, 2024
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
73 changes: 72 additions & 1 deletion src/__private_stories__/tooltip-scenarios-story.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
import * as React from 'react';
import {Stack, Text3, Tooltip, Placeholder, IconShopRegular, Title3} from '..';
import {
Stack,
Text3,
Tooltip,
Placeholder,
IconShopRegular,
Title3,
Grid,
GridItem,
SnapCard,
Circle,
IconAcademicRegular,
} from '..';
import {vars} from '../skins/skin-contract.css';

export default {
title: 'Private/Tooltip',
Expand Down Expand Up @@ -142,3 +155,61 @@ export const MultipleTooltips: StoryComponent = () => {
};

MultipleTooltips.storyName = 'Multiple tooltips';

export const WithTargetStyles: StoryComponent = () => {
return (
<Stack space={16}>
<Stack space={8}>
<Title3>Tooltip with custom CSS styles for the target wrapper</Title3>
<Text3 regular as="p">
Sometimes you may need to style the element that wraps the target content. You can use the
targetStyle prop for this.
</Text3>
</Stack>
<Grid columns={2} gap={8}>
<GridItem>
<Tooltip
targetStyle={{height: '100%'}}
position="bottom"
target={
<SnapCard
dataAttributes={{testid: 'target-0'}}
asset={
<Circle size={40} backgroundColor={vars.colors.brandLow}>
<IconAcademicRegular color={vars.colors.brand} />
</Circle>
}
description="Description description description description description description description description description description description description description description description description description description description description"
title="Title"
/>
}
title="Title"
description="Description"
/>
</GridItem>
<GridItem>
<Tooltip
targetStyle={{height: '100%'}}
position="bottom"
target={
<SnapCard
dataAttributes={{testid: 'target-1'}}
asset={
<Circle size={40} backgroundColor={vars.colors.brandLow}>
<IconAcademicRegular color={vars.colors.brand} />
</Circle>
}
title="Title"
description="Description"
/>
}
title="Title"
description="Description"
/>
</GridItem>
</Grid>
</Stack>
);
};

WithTargetStyles.storyName = 'With custom styles for target';
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions src/__screenshot_tests__/tooltip-screenshot-test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,26 @@ test('Tooltip - active tooltip is closed if another one is opened', async () =>
expect(thirdTooltip).toMatchImageSnapshot();
});

test('Tooltip - with targetStyle', async () => {
const page = await openStoryPage({
id: 'private-tooltip--with-target-styles',
device: 'DESKTOP',
});

const noOpenTooltip = await page.screenshot();
expect(noOpenTooltip).toMatchImageSnapshot();

await page.click(await screen.findByTestId('target-0'));

const firstTooltip = await page.screenshot();
expect(firstTooltip).toMatchImageSnapshot();

await page.click(await screen.findByTestId('target-1'));

const secondTooltip = await page.screenshot();
expect(secondTooltip).toMatchImageSnapshot();
});

/**
* when using Vivo_new skin, the tooltip border radius is bigger than in other skins, so it's useful
* to check that the tooltip's arrow is displayed properly in this scenario.
Expand Down
1 change: 1 addition & 0 deletions src/popover.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ type Position = 'top' | 'bottom' | 'left' | 'right';
type Props = {
description?: string;
target: React.ReactNode;
targetStyle?: React.CSSProperties;
title?: string;
asset?: React.ReactNode;
onClose?: () => void;
Expand Down
4 changes: 4 additions & 0 deletions src/tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ type Props = {
extra?: React.ReactNode;
description?: string;
target: React.ReactNode;
targetStyle?: React.CSSProperties;
title?: string;
position?: Position;
width?: number;
Expand All @@ -147,6 +148,7 @@ type Props = {
type BaseTooltipProps = {
content?: React.ReactNode;
target: React.ReactNode;
targetStyle?: React.CSSProperties;
position?: Position;
width?: number;
delay?: boolean;
Expand All @@ -162,6 +164,7 @@ type BaseTooltipProps = {
export const BaseTooltip = ({
content,
target,
targetStyle,
width,
position = 'top',
dataAttributes,
Expand Down Expand Up @@ -445,6 +448,7 @@ export const BaseTooltip = ({
<>
{/* eslint-disable-next-line jsx-a11y/no-static-element-interactions */}
<div
style={targetStyle}
ref={(element) => {
/**
* Hack to set the target ref to the target element that was actually passed as prop.
Expand Down
Loading