Skip to content
Open
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
5 changes: 5 additions & 0 deletions .changeset/nine-peaches-notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@sumup-oss/circuit-ui": patch
---

Centralized the "Close" label translations in CloseButton component and made the label optional in components that require it.
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ export const ComboboxInput = forwardRef<HTMLInputElement, ComboboxInputProps>(
readOnly={readOnly}
{...props}
/>
{value && onClear && clearLabel && (
{value && onClear && (
<CloseButton
className={classes.clear}
size="s"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export const CardHeader = forwardRef<HTMLDivElement, CardHeaderProps>(
{...props}
>
{children}
{onClose && closeButtonLabel && (
{onClose && (
<CloseButton className={classes.close} onClick={onClose}>
{closeButtonLabel}
</CloseButton>
Expand Down
19 changes: 11 additions & 8 deletions packages/circuit-ui/components/CloseButton/CloseButton.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,32 @@
import { describe, expect, it } from 'vitest';
import { createRef } from 'react';

import { axe, render } from '../../util/test-utils.js';
import { axe, render, screen } from '../../util/test-utils.js';

import { CloseButton } from './CloseButton.js';

describe('CloseButton', () => {
it('should merge a custom class name with the default ones', () => {
const className = 'foo';
const { container } = render(
<CloseButton label="Close" className={className} />,
);
const button = container.querySelector('button');
render(<CloseButton className={className}>Close</CloseButton>);
const button = screen.getByRole('button', { name: 'Close' });
expect(button?.className).toContain(className);
});

it('should forward a ref', () => {
const ref = createRef<HTMLHRElement>();
const { container } = render(<CloseButton label="Close" ref={ref} />);
const button = container.querySelector('button');
render(<CloseButton ref={ref}>Close</CloseButton>);
const button = screen.getByRole('button', { name: 'Close' });
Comment on lines +33 to +34
Copy link
Member

Choose a reason for hiding this comment

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

💙

expect(ref.current).toBe(button);
});

it('should render with default translated label', () => {
render(<CloseButton locale="fr-FR" />);
expect(screen.getByText('Fermer')).toBeVisible();
});

it('should meet accessibility guidelines', async () => {
const { container } = render(<CloseButton label="Close" />);
const { container } = render(<CloseButton>Close</CloseButton>);
const actual = await axe(container);
expect(actual).toHaveNoViolations();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,3 @@ export default {
};

export const Base = (args: CloseButtonProps) => <CloseButton {...args} />;

Base.args = {
children: 'Close',
};
15 changes: 9 additions & 6 deletions packages/circuit-ui/components/CloseButton/CloseButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,29 @@
import { forwardRef } from 'react';
import { Close } from '@sumup-oss/icons';

import { IconButton, type IconButtonProps } from '../Button/IconButton.js';
import { IconButton, type IconButtonProps } from '../Button/index.js';
import { useI18n } from '../../hooks/useI18n/useI18n.js';
import { translations } from './translations/index.js';

export type CloseButtonProps = Omit<IconButtonProps, 'icon'>;

/**
* A generic close button.
*/

export const CloseButton = forwardRef<any, CloseButtonProps>(
({ label = 'Close', children = label, ...props }, ref) => (
export const CloseButton = forwardRef<any, CloseButtonProps>((props, ref) => {
const { label, children = label, ...rest } = useI18n(props, translations);
return (
<IconButton
type="button"
variant="tertiary"
{...props}
{...rest}
icon={Close}
ref={ref}
>
{children}
</IconButton>
),
);
);
});

CloseButton.displayName = 'CloseButton';
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Затвори"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Zavřít"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Luk"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Schließen"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Schliessen"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Schließen"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Schließen"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Κλείσιμο"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Κλείσιμο"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Close"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Close"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Close"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Close"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Close"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Cerrar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Sulge"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Sulje"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fermer"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fermer"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fermer"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fermer"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Zatvori"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Bezárás"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Chiudi"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Chiudi"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Uždaryti"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Aizvērt"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Lukk"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Sluit"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Sluiten"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Zamknij"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fechar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Fechar"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Închide"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Zatvoriť"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Zapri"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Stäng"
}
10 changes: 5 additions & 5 deletions packages/circuit-ui/components/Dialog/Dialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,9 @@ import { clsx } from '../../styles/clsx.js';
import { useClickOutside } from '../../hooks/useClickOutside/index.js';
import { useEscapeKey } from '../../hooks/useEscapeKey/index.js';
import { useLatest } from '../../hooks/useLatest/index.js';
import { useI18n } from '../../hooks/useI18n/useI18n.js';
import { useSwipe } from '../../hooks/useSwipe/index.js';

import classes from './Dialog.module.css';
import { translations } from './translations/index.js';

type DataAttribute = `data-${string}`;

Expand Down Expand Up @@ -119,8 +117,8 @@ export interface DialogProps extends PublicDialogProps {
}

export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
(props, ref) => {
const {
(
{
open,
isModal = false,
children,
Expand All @@ -136,7 +134,9 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
locale,
style,
...rest
} = useI18n(props, translations);
},
ref,
) => {
const dialogRef = useRef<HTMLDialogElement>(null);
const openRef = useLatest<boolean>(open);
const isModalRef = useLatest<boolean>(isModal);
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading