aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2023-10-04 15:06:29 +0200
committerArmand Philippot <git@armandphilippot.com>2023-11-11 18:14:41 +0100
commite97325a2c174a87c29593d1b42b9a1cc1eaf11af (patch)
tree8bc2f9bd386512350ef596729dae1a9b14b7f3fd /src/components/molecules
parent9eeb49155e2e74df4d5cb2833da20669b85fafe5 (diff)
refactor(components): rewrite HelpButton component
Diffstat (limited to 'src/components/molecules')
-rw-r--r--src/components/molecules/buttons/help-button.module.scss20
-rw-r--r--src/components/molecules/buttons/help-button.test.tsx10
-rw-r--r--src/components/molecules/buttons/help-button.tsx40
-rw-r--r--src/components/molecules/buttons/help-button/help-button.module.scss24
-rw-r--r--src/components/molecules/buttons/help-button/help-button.stories.tsx (renamed from src/components/molecules/buttons/help-button.stories.tsx)5
-rw-r--r--src/components/molecules/buttons/help-button/help-button.test.tsx13
-rw-r--r--src/components/molecules/buttons/help-button/help-button.tsx42
-rw-r--r--src/components/molecules/buttons/help-button/index.ts1
-rw-r--r--src/components/molecules/tooltip/tooltip.module.scss20
-rw-r--r--src/components/molecules/tooltip/tooltip.tsx20
10 files changed, 104 insertions, 91 deletions
diff --git a/src/components/molecules/buttons/help-button.module.scss b/src/components/molecules/buttons/help-button.module.scss
deleted file mode 100644
index fb28b57..0000000
--- a/src/components/molecules/buttons/help-button.module.scss
+++ /dev/null
@@ -1,20 +0,0 @@
-@use "../../../styles/abstracts/mixins" as mix;
-
-.btn {
- padding: var(--spacing-xs);
-
- &:not(:disabled) {
- &:focus {
- text-decoration: none;
- }
- }
-
- @include mix.pointer("fine") {
- padding: var(--spacing-2xs);
- }
-}
-
-.icon {
- color: var(--color-primary-dark);
- font-weight: 600;
-}
diff --git a/src/components/molecules/buttons/help-button.test.tsx b/src/components/molecules/buttons/help-button.test.tsx
deleted file mode 100644
index 85daf30..0000000
--- a/src/components/molecules/buttons/help-button.test.tsx
+++ /dev/null
@@ -1,10 +0,0 @@
-import { describe, expect, it } from '@jest/globals';
-import { render, screen } from '../../../../tests/utils';
-import { HelpButton } from './help-button';
-
-describe('Help', () => {
- it('renders a help button', () => {
- render(<HelpButton />);
- expect(screen.getByRole('button', { name: 'Help ?' })).toBeInTheDocument();
- });
-});
diff --git a/src/components/molecules/buttons/help-button.tsx b/src/components/molecules/buttons/help-button.tsx
deleted file mode 100644
index 7a01b14..0000000
--- a/src/components/molecules/buttons/help-button.tsx
+++ /dev/null
@@ -1,40 +0,0 @@
-import { forwardRef, type ForwardRefRenderFunction } from 'react';
-import { useIntl } from 'react-intl';
-import { Button, type ButtonProps } from '../../atoms';
-import styles from './help-button.module.scss';
-
-export type HelpButtonProps = Pick<
- ButtonProps,
- 'className' | 'isPressed' | 'onClick'
->;
-
-const HelpButtonWithRef: ForwardRefRenderFunction<
- HTMLButtonElement,
- HelpButtonProps
-> = ({ className = '', ...props }, ref) => {
- const intl = useIntl();
- const text = intl.formatMessage({
- defaultMessage: 'Help',
- id: 'i+/ckF',
- description: 'HelpButton: screen reader text',
- });
-
- return (
- <Button
- className={`${styles.btn} ${className}`}
- ref={ref}
- shape="circle"
- {...props}
- >
- <span className="screen-reader-text">{text}</span>
- <span className={styles.icon}>?</span>
- </Button>
- );
-};
-
-/**
- * HelpButton component
- *
- * Render a button with an interrogation mark icon.
- */
-export const HelpButton = forwardRef(HelpButtonWithRef);
diff --git a/src/components/molecules/buttons/help-button/help-button.module.scss b/src/components/molecules/buttons/help-button/help-button.module.scss
new file mode 100644
index 0000000..2dbba69
--- /dev/null
+++ b/src/components/molecules/buttons/help-button/help-button.module.scss
@@ -0,0 +1,24 @@
+@use "../../../../styles/abstracts/functions" as fun;
+@use "../../../../styles/abstracts/mixins" as mix;
+
+.btn {
+ padding: fun.convert-px(7);
+
+ @include mix.pointer("fine") {
+ padding: fun.convert-px(4);
+ }
+
+ &[aria-pressed="true"] {
+ background: var(--color-primary-dark);
+ border-color: var(--color-primary-dark);
+ box-shadow: fun.convert-px(1) fun.convert-px(1) 0 0 var(--color-shadow);
+
+ .icon {
+ :global {
+ path {
+ fill: var(--color-fg-inverted);
+ }
+ }
+ }
+ }
+}
diff --git a/src/components/molecules/buttons/help-button.stories.tsx b/src/components/molecules/buttons/help-button/help-button.stories.tsx
index 176888c..556dd74 100644
--- a/src/components/molecules/buttons/help-button.stories.tsx
+++ b/src/components/molecules/buttons/help-button/help-button.stories.tsx
@@ -1,4 +1,4 @@
-import { ComponentMeta, ComponentStory } from '@storybook/react';
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
import { HelpButton as HelpButtonComponent } from './help-button';
/**
@@ -45,3 +45,6 @@ const Template: ComponentStory<typeof HelpButtonComponent> = (args) => (
* Help Button Stories - Level 1
*/
export const HelpButton = Template.bind({});
+HelpButton.args = {
+ label: 'Help',
+};
diff --git a/src/components/molecules/buttons/help-button/help-button.test.tsx b/src/components/molecules/buttons/help-button/help-button.test.tsx
new file mode 100644
index 0000000..f36fba7
--- /dev/null
+++ b/src/components/molecules/buttons/help-button/help-button.test.tsx
@@ -0,0 +1,13 @@
+import { describe, expect, it } from '@jest/globals';
+import { render, screen as rtlScreen } from '@testing-library/react';
+import { HelpButton } from './help-button';
+
+describe('Help', () => {
+ it('renders a help button', () => {
+ const label = 'hic';
+
+ render(<HelpButton label={label} />);
+
+ expect(rtlScreen.getByRole('button')).toHaveAccessibleName(label);
+ });
+});
diff --git a/src/components/molecules/buttons/help-button/help-button.tsx b/src/components/molecules/buttons/help-button/help-button.tsx
new file mode 100644
index 0000000..1951b4d
--- /dev/null
+++ b/src/components/molecules/buttons/help-button/help-button.tsx
@@ -0,0 +1,42 @@
+import { forwardRef, type ForwardRefRenderFunction } from 'react';
+import { Button, VisuallyHidden, type ButtonProps, Icon } from '../../../atoms';
+import styles from './help-button.module.scss';
+
+export type HelpButtonProps = Omit<
+ ButtonProps,
+ 'aria-label' | 'children' | 'kind' | 'shape'
+> & {
+ /**
+ * Define an accessible name for the button.
+ */
+ label: string;
+};
+
+const HelpButtonWithRef: ForwardRefRenderFunction<
+ HTMLButtonElement,
+ HelpButtonProps
+> = ({ className = '', isPressed = false, label, ...props }, ref) => {
+ const btnClass = `${styles.btn} ${className}`;
+
+ return (
+ <Button
+ {...props}
+ className={btnClass}
+ isPressed={isPressed}
+ ref={ref}
+ // eslint-disable-next-line react/jsx-no-literals -- Shape allowed
+ shape="circle"
+ >
+ {/* eslint-disable-next-line react/jsx-no-literals -- Config allowed */}
+ <Icon aria-hidden className={styles.icon} shape="help" size="sm" />
+ <VisuallyHidden>{label}</VisuallyHidden>
+ </Button>
+ );
+};
+
+/**
+ * HelpButton component
+ *
+ * Render a button with an interrogation mark icon.
+ */
+export const HelpButton = forwardRef(HelpButtonWithRef);
diff --git a/src/components/molecules/buttons/help-button/index.ts b/src/components/molecules/buttons/help-button/index.ts
new file mode 100644
index 0000000..952119e
--- /dev/null
+++ b/src/components/molecules/buttons/help-button/index.ts
@@ -0,0 +1 @@
+export * from './help-button';
diff --git a/src/components/molecules/tooltip/tooltip.module.scss b/src/components/molecules/tooltip/tooltip.module.scss
index 029767f..557d9c7 100644
--- a/src/components/molecules/tooltip/tooltip.module.scss
+++ b/src/components/molecules/tooltip/tooltip.module.scss
@@ -38,14 +38,6 @@
opacity: 1;
visibility: visible;
transform: scale(1);
-
- & ~ .btn {
- background: var(--color-primary);
-
- * {
- color: var(--color-fg-inverted);
- }
- }
}
}
@@ -60,13 +52,15 @@
.icon {
align-self: stretch;
- display: flex;
- align-items: center;
margin-right: var(--spacing-xs);
- padding: 0 var(--spacing-2xs);
background: var(--color-primary-dark);
border: fun.convert-px(1) solid var(--color-primary-dark);
box-shadow: fun.convert-px(1) fun.convert-px(1) 0 0 var(--color-shadow);
- color: var(--color-fg-inverted);
- font-weight: 600;
+
+ :global {
+ path {
+ fill: var(--color-fg-inverted);
+ margin-inline: var(--spacing-2xs);
+ }
+ }
}
diff --git a/src/components/molecules/tooltip/tooltip.tsx b/src/components/molecules/tooltip/tooltip.tsx
index 43ceced..1f54d68 100644
--- a/src/components/molecules/tooltip/tooltip.tsx
+++ b/src/components/molecules/tooltip/tooltip.tsx
@@ -1,8 +1,9 @@
-import { FC, MouseEventHandler, useRef } from 'react';
-import { Heading, Modal, ModalProps } from '../../atoms';
+import { type FC, type MouseEventHandler, useRef } from 'react';
+import { useIntl } from 'react-intl';
+import { useOnClickOutside } from '../../../utils/hooks';
+import { Heading, Icon, Modal, type ModalProps } from '../../atoms';
import { HelpButton } from '../buttons';
import styles from './tooltip.module.scss';
-import { useOnClickOutside } from '../../../utils/hooks';
export type TooltipProps = Omit<ModalProps, 'heading'> & {
/**
@@ -47,6 +48,12 @@ export const Tooltip: FC<TooltipProps> = ({
onToggle,
...props
}) => {
+ const intl = useIntl();
+ const helpLabel = intl.formatMessage({
+ defaultMessage: 'Show help',
+ description: 'Tooltip: show help label',
+ id: '1Xgg7+',
+ });
const directionModifier =
direction === 'upwards' ? 'tooltip--up' : 'tooltip--down';
const visibilityModifier = isOpen ? 'tooltip--visible' : 'tooltip--hidden';
@@ -70,9 +77,7 @@ export const Tooltip: FC<TooltipProps> = ({
className={tooltipClass}
heading={
<Heading className={styles.heading} isFake level={6}>
- <span aria-hidden className={styles.icon}>
- ?
- </span>
+ <Icon aria-hidden className={styles.icon} shape="help" size="sm" />
{heading}
</Heading>
}
@@ -82,8 +87,9 @@ export const Tooltip: FC<TooltipProps> = ({
{children}
</Modal>
<HelpButton
- aria-pressed={isOpen}
className={styles.btn}
+ isPressed={isOpen}
+ label={helpLabel}
onClick={onToggle}
ref={btnRef}
/>