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

Prevent expanding/collapsing a notification when clicking the action button #48074

Merged
merged 2 commits into from
Oct 30, 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
2 changes: 1 addition & 1 deletion web/packages/design/src/Alert/Alert.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ interface Props<K> {
export interface Action {
content: React.ReactNode;
href?: string;
onClick?: () => void;
onClick?: (event: React.MouseEvent) => void;
}

export interface AlertProps
Expand Down
49 changes: 49 additions & 0 deletions web/packages/shared/components/Notification/Notification.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* Teleport
* Copyright (C) 2024 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

import { render } from 'design/utils/testing';
import { fireEvent, screen } from '@testing-library/react';

import { Notification } from './Notification';

test('click on action button does not expand or collapse notification', async () => {
const description = 'An error happened';

render(
<Notification
item={{
id: '865801ca',
severity: 'error',
content: {
title: 'Warning',
description,
action: { content: 'Retry' },
},
}}
onRemove={() => {}}
/>
);

fireEvent.click(screen.getByText('Retry'));

// Check if the text still has the initial, "collapsed" style (look at shortTextCss).
expect(screen.getByText(description)).toHaveStyleRule(
'-webkit-line-clamp',
'3'
);
});
17 changes: 15 additions & 2 deletions web/packages/shared/components/Notification/Notification.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ const NotificationBody = ({
const longerTextCss = isExpanded ? textCss : shortTextCss;
const hasListOrDescription = !!content.list || !!content.description;

const { action } = content;

return (
<>
{/* Note: an empty <Text/> element would still generate a flex gap, so we
Expand All @@ -237,9 +239,20 @@ const NotificationBody = ({
{content.description}
</Text>
)}
{content.action && (
{action && (
<Box alignSelf="flex-start">
<ActionButton intent="neutral" action={content.action} />
<ActionButton
intent="neutral"
action={{
href: action.href,
content: action.content,
onClick: event => {
// Prevents toggling the isExpanded flag.
event.stopPropagation();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way we can add a test for this? It's a rather niche interaction that can easily regress in the future. OTOH, as isExpanded merely controls the styles, I don't think the JSDOM-based tests are going to be able to detect the difference.

Copy link
Contributor Author

@gzdunek gzdunek Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we can't detect the text overflow. Instead, I added a test that checks if the style wasn't modified by the click. What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should be good enough for now! I didn't realize that toHaveStyleRule works with CSS in general, I've always assumed it only works when the style is set directly on a node.

action.onClick?.(event);
},
}}
/>
</Box>
)}
</>
Expand Down
Loading